Skip to content

Add documentation of log levels#93

Merged
tfoote merged 2 commits intomasterfrom
tfoote-patch-1
May 15, 2020
Merged

Add documentation of log levels#93
tfoote merged 2 commits intomasterfrom
tfoote-patch-1

Conversation

@tfoote
Copy link
Copy Markdown
Contributor

@tfoote tfoote commented Apr 2, 2020

Signed-off-by: Tully Foote <tfoote@osrfoundation.org>
## 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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not only in the future but custom user defined levels.

@hidmic
Copy link
Copy Markdown

hidmic commented Apr 16, 2020

@tfoote friendly ping.

Signed-off-by: Tully Foote <tfoote@osrfoundation.org>
@tfoote tfoote requested a review from dirk-thomas May 15, 2020 08:49
## 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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity: why two #? Are these comments still being extracted properly and used in the generated code without any leading #?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was just copying the existing style.

@tfoote tfoote merged commit 018fe20 into master May 15, 2020
@delete-merged-branch delete-merged-branch bot deleted the tfoote-patch-1 branch May 15, 2020 23:05
@dirk-thomas
Copy link
Copy Markdown
Member

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants