Improve documentation in rclpy.utilities #1038
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: Shane Loretz <sloretz@osrfoundation.org>
sloretz
force-pushed
the
sloretz__rclpy__improve_utilities_docs
branch
from
9b3dc08
to
0407828
Compare
fujitatomoya
approved these changes
Nov 13, 2022
|
CI (build:
|
delete-merged-branch
bot
deleted the
sloretz__rclpy__improve_utilities_docs
branch
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 type annotations and doc strings to the functions in
rclpy.utilities. I didn't change any behavior of the functions (maybe this is backportable?). I did remove a couple unnecessaryreturnstatements ( they were returning the value from another function that itself always returnsNone).Here's how it looks now