Skip to content

added more description to logging and a python example#145

Draft
jlheflin wants to merge 4 commits intomasterfrom
add_python_logging_example
Draft

added more description to logging and a python example#145
jlheflin wants to merge 4 commits intomasterfrom
add_python_logging_example

Conversation

@jlheflin
Copy link
Contributor

@jlheflin jlheflin commented May 6, 2025

Is this pull request associated with an issue(s)?
No

Description
Adds a Python example that shows the difference between severity outputs. Also expanded the docs a little bit to better explain this.

TODOs
Should be r2g after review.

Copy link
Member

@ryanmrichard ryanmrichard left a comment

Choose a reason for hiding this comment

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

It would also be good to have a C++ example. Without the C++ example, a reader may think that this is a Python-only feature.

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
all logging statements set as trace and below are enabled if the severity of
all logging statements with severity trace and above are enabled if the severity of

Comment on lines 191 to 219
Copy link
Member

Choose a reason for hiding this comment

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

Please use literalinclude and ensure your code is tested. Please also explain what your code is showing (in your case, it illustrates the difference in output when using different severities).

Comment on lines 183 to 185
Copy link
Member

Choose a reason for hiding this comment

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

This is not valid reST (the headers/underlines must be the same length as the title).

Comment on lines 152 to 156
Copy link
Member

@jwaldrop107 jwaldrop107 May 6, 2025

Choose a reason for hiding this comment

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

I honestly think explicitly stating all of these is redundant with the above explanation. I would only provide one explicit example of one of the intermediate values, probably either info or warn.

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

Comments