Improve documentation for TransformStamped.msg #113
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes #94 Signed-off-by: Tully Foote <tfoote@osrfoundation.org>
hidmic
reviewed
May 18, 2020
| # See its documentation for more information. | ||
| # | ||
| # The child_frame_id is necessary in addition to the frame_id | ||
| # in the Header to communication the full reference for the transform |
There was a problem hiding this comment.
Suggested change
| # in the Header to communication the full reference for the transform | |
| # in the Header to communicate the full reference for the transform |
There was a problem hiding this comment.
I do wonder if this paragraph isn't just redundant with the definition of transform and the first paragraph.
There was a problem hiding this comment.
It is somewhat redundant but people asked for clarification in the API review so I figured another sentence could help.
| # | ||
| # This message is mostly used by the | ||
| # <a href="http://www.ros.org/wiki/tf">tf</a> package. | ||
| # <a href="http://www.ros.org/wiki/tf2">tf2</a> package. |
There was a problem hiding this comment.
@tfoote hmm are we reusing the ROS wiki for ROS 2?
There was a problem hiding this comment.
Good point updated to use index.ros.org
Signed-off-by: Tully Foote <tfoote@osrfoundation.org>
jacobperron
approved these changes
May 19, 2020
jacobperron
approved these changes
May 19, 2020
hidmic
approved these changes
May 19, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #94