Skip to content

[3.12] gh-129143: Fix incorrect documentation for logging.Handler.close(). (GH-129950) #129952

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 1 commit into from
Feb 10, 2025
Merged

[3.12] gh-129143: Fix incorrect documentation for logging.Handler.close(). (GH-129950) #129952

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 6 additions & 4 deletions Doc/library/logging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -592,10 +592,12 @@ subclasses. However, the :meth:`!__init__` method in subclasses needs to call

.. method:: Handler.close()

Tidy up any resources used by the handler. This version does no output but
removes the handler from an internal list of handlers which is closed when
:func:`shutdown` is called. Subclasses should ensure that this gets called
from overridden :meth:`close` methods.
Tidy up any resources used by the handler. This version does no output
but removes the handler from an internal map of handlers, which is used
for handler lookup by name.

Subclasses should ensure that this gets called from overridden :meth:`close`
methods.


.. method:: Handler.handle(record)
Expand Down
Loading