Clean up the broken Class and Function links in docstrings #414
Conversation
| @@ -119,7 +119,7 @@ def __data__(self): | |||
|
|
|||
|
|
|||
| class AttachedCollisionMesh(Data): | |||
| """Represents a collision mesh that is attached to a :class:`Robot`'s :class:`~compas_robots.model.Link`. | |||
| """Represents a collision mesh that is attached to a :class:`Robot`'s :class:`compas_robots.model.Link`. | |||
There was a problem hiding this comment.
I actually like this with the ~ better, otherwise it is too verbose, don't you think?
There was a problem hiding this comment.
Yea. But is it clear to people that compas_robots is a different package? At the moment if you pretend you are a user following that clickable link, you will reach a page that simply list the class Link. Somehow misleading that the Link class belongs to compas_fab.
I think if the API documentation page theme is slightly different between compas_fab and compas_robots, (maybe a different colour) then we can go with ~ for all the compas_robot links.
There was a problem hiding this comment.
You're right, it's useful to keep the full link in these cases, to highlight it's an external module. Altering the colors of fab would be a bit against the idea of having homogenous docs for all compas, so, let's stick with full link
yck011522
changed the title
|
@gonzalocasas Fixed all your comments, we need to discuss only one thing. Whether to use the ~ for external links that points to compas_robots |
| @@ -119,7 +119,7 @@ def __data__(self): | |||
|
|
|||
|
|
|||
| class AttachedCollisionMesh(Data): | |||
| """Represents a collision mesh that is attached to a :class:`Robot`'s :class:`~compas_robots.model.Link`. | |||
| """Represents a collision mesh that is attached to a :class:`Robot`'s :class:`compas_robots.model.Link`. | |||
There was a problem hiding this comment.
You're right, it's useful to keep the full link in these cases, to highlight it's an external module. Altering the colors of fab would be a bit against the idea of having homogenous docs for all compas, so, let's stick with full link
Co-authored-by: Gonzalo Casas <[email protected]>
Co-authored-by: Gonzalo Casas <[email protected]>
Co-authored-by: Gonzalo Casas <[email protected]>
What type of change is this?
Checklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.CHANGELOG.mdfile in theUnreleasedsection under the most fitting heading (e.g.Added,Changed,Removed).invoke test).invoke lint).compas_fab.robots.CollisionMesh.