[doc] Clarify the nature of the root logger in the logging documentation
#119440
Conversation
The way it's currently written, it's very confusing what the root logger's name is, because it's not explicitly stated anywhere (the how-to page says that its name "is printed as 'root'", which makes it sound like it's actually something else, but it's not it's just 'root'), and because it is stated that the logging hierarchy is based on period-separated names (this is true except for "root", and that exception isn't stated anywhere here).
|
All commit authors signed the Contributor License Agreement. |
bedevere-app
bot
added
docs
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
Understood about not wanting people to rely on the root logger's name being `'root'`. I rephrased it to always refer to the root logger as simply "the root logger", as is done in the rest of the document.
|
I have made the requested changes; please review again. |
|
Thanks for making the requested changes! @vsajip: please review the changes made to this pull request. |
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
|
Sure, that works for me. I have made the requested changes; please review again. |
|
Thanks for making the requested changes! @vsajip: please review the changes made to this pull request. |
vsajip
changed the title
logging documentationlogging documentation
vsajip
added
needs backport to 3.12
|
Thanks @jkunimune for the PR, and @vsajip for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13. |
|
Thanks @jkunimune for the PR, and @vsajip for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12. |
…ation (pythonGH-119440) (cherry picked from commit b407ad3) Co-authored-by: Justin Kunimune <justinkunimune@gmail.com> Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
…ation (pythonGH-119440) (cherry picked from commit b407ad3) Co-authored-by: Justin Kunimune <justinkunimune@gmail.com> Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
|
GH-119651 is a backport of this pull request to the 3.13 branch. |
|
GH-119652 is a backport of this pull request to the 3.12 branch. |
The way it's currently written, it's very confusing what the root logger's name is, because it's not explicitly stated anywhere (the how-to page says that its name "is printed as 'root'", which makes it sound like it's actually something else, but it's not it's just 'root'), and because it is stated that the logging hierarchy is based on period-separated names ("root" is the exception to this rule, and that exception isn't stated anywhere here).
📚 Documentation preview 📚: https://cpython-previews--119440.org.readthedocs.build/