-
Notifications
You must be signed in to change notification settings - Fork 45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Python docstring for message documentation #196
Comments
guillaumeautran
added a commit
to clearpathrobotics/rosidl_python
that referenced
this issue
Jun 13, 2023
issue: ros2#196 Transcribed the original message comments in the python docstring
guillaumeautran
added a commit
to clearpathrobotics/rosidl_python
that referenced
this issue
Jun 13, 2023
issue: ros2#196 Transcribed the original message comments in the python docstring
guillaumeautran
added a commit
to clearpathrobotics/rosidl_python
that referenced
this issue
Jun 15, 2023
issue: ros2#196 Transcribed the original message comments in the python docstring
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Enhancement Request
Required Info:
Steps to reproduce issue
When looking at a message class documentation in Python, the message comments don't really show making it more complicated to understand the message.
For example take the statistics_msgs/MetricsMessage, the source file has lots of good documentation for the message itself as well as for each of the fields contained in the message.
When looking at the python documentation for the message, we see:
All of this without any of the message creator help data.
Expected behavior
Instead, we could build in the documentation comments from the original message documentation into the python class docstring making it better for developers to access the documentation.
A potential outcome for this message type:
Feature request
Feature description
Transfer message file documentation into python docstrings for the corresponding message.
The text was updated successfully, but these errors were encountered: