Finish up API documentation #123
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
Signed-off-by: Stephen Brawner <brawner@gmail.com>
ahcorde
approved these changes
Jun 4, 2020
Blast545
approved these changes
Jun 4, 2020
Comment on lines
5
to
7
| # Single DOF joint positions for each joint relative to their "0" position. | ||
| # The units depend on the specific joint type: radians for revolute and | ||
| # continuous joints and meters for prismatic joints. |
There was a problem hiding this comment.
The repeated "and" makes it a bit confusing to read, maybe something like:
Suggested change
| # Single DOF joint positions for each joint relative to their "0" position. | |
| # The units depend on the specific joint type: radians for revolute and | |
| # continuous joints and meters for prismatic joints. | |
| # Single DOF joint positions for each joint relative to their "0" position. | |
| # The units depend on the specific joint type: radians for revolute and | |
| # continuous joints while meters for prismatic joints. |
(or a comma separation as the one below this)
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.
This adds API documentation to each message and service that didn't already have them.
Signed-off-by: Stephen Brawner brawner@gmail.com