Add documentation of log levels #93
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: Tully Foote <tfoote@osrfoundation.org>
dirk-thomas
reviewed
Apr 2, 2020
rcl_interfaces/msg/Log.msg
Outdated
| ## https://docs.python.org/3/library/logging.html#logging-levels | ||
| ## And are implemented in rcutils as well | ||
| ## https://github.com/ros2/rcutils/blob/35f29850064e0c33a4063cbc947ebbfeada11dba/include/rcutils/logging.h#L164-L172 | ||
| ## This leaves space for other logging levels to be inserted in the middle in the future. |
There was a problem hiding this comment.
Not only in the future but custom user defined levels.
|
@tfoote friendly ping. |
Signed-off-by: Tully Foote <tfoote@osrfoundation.org>
dirk-thomas
approved these changes
May 15, 2020
dirk-thomas
reviewed
May 15, 2020
| ## This leaves space for other standard logging levels to be inserted in the middle in the future, | ||
| ## as well as custom user defined levels. | ||
| ## Since there are several other logging enumeration standard for different implementations, | ||
| ## other logging implementations may need to provide level mappings to match their internal implementations. |
There was a problem hiding this comment.
Out of curiosity: why two #? Are these comments still being extracted properly and used in the generated code without any leading #?
There was a problem hiding this comment.
I was just copying the existing style.
|
Please double check the docblocks in the generated code. That was also part of the review if I recall correctly. |
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 is a follow up to the Aggregate Foxy Message API Review
Specifically: https://github.com/ros2/common_interfaces/pull/86/files#r393330197