8000 [doc] Clarify the nature of the root logger in the `logging` documentation by jkunimune · Pull Request #119440 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

[doc] Clarify the nature of the root logger in the logging documentation #119440

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
May 28, 2024
Merged

[doc] Clarify the nature of the root logger in the logging documentation #119440

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c302708
clarify details of root logger
jkunimune May 22, 2024
9b1c761
Refer to the root logger consistently in the documentation
jkunimune May 24, 2024
323741c
Update Doc/library/logging.rst
jkunimune May 25, 2024
89024a1
Fix cross-reference and reformat paragraphs.
vsajip May 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update Doc/library/logging.rst 
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
  • Loading branch information
@jkunimune @vsajip
jkunimune and vsajip authored May 25, 2024
commit 323741c2abbacfa9d6c8b6443b60964744110325
2 changes: 1 addition & 1 deletion Doc/library/logging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1161,7 +1161,7 @@ functions.
Return a logger with the specified name or, if name is ``None``, return the
root logger of the hierarchy. If specified, the name is
typically a dot-separated hierarchical name like *'a'*, *'a.b'* or *'a.b.c.d'*.
Choice of these names is entirely up to the developer who is using logging.
Choice of these names is entirely up to the developer who is using logging, though it is recommended that ``__name__`` be used unless you have a specific reason for not doing that, as mentioned in :ref:`logger-objects`.

All calls to this function with a given name return the same logger instance.
This means that logger instances never need to be passed between different parts
Expand Down
0