Skip to content

Commit

Permalink
[3.11] gh-107028: tiny textual changes in logging docs and docstrings (
Browse files Browse the repository at this point in the history
…GH-107029) (GH-107066)

(cherry picked from commit 5e5a34a)
  • Loading branch information
miss-islington authored Jul 22, 2023
1 parent 2895dbd commit 9875b17
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
9 changes: 5 additions & 4 deletions Doc/library/logging.handlers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -917,8 +917,9 @@ should, then :meth:`flush` is expected to do the flushing.

.. method:: flush()

You can override this to implement custom flushing behavior. This version
just zaps the buffer to empty.
For a :class:`BufferingHandler` instance, flushing means that it sets the
buffer to an empty list. This method can be overwritten to implement more useful
flushing behavior.


.. method:: shouldFlush(record)
Expand Down Expand Up @@ -950,9 +951,9 @@ should, then :meth:`flush` is expected to do the flushing.

.. method:: flush()

For a :class:`MemoryHandler`, flushing means just sending the buffered
For a :class:`MemoryHandler` instance, flushing means just sending the buffered
records to the target, if there is one. The buffer is also cleared when
this happens. Override if you want different behavior.
buffered records are sent to the target. Override if you want different behavior.


.. method:: setTarget(target)
Expand Down
2 changes: 1 addition & 1 deletion Lib/logging/handlers.py
Original file line number Diff line number Diff line change
Expand Up @@ -1399,7 +1399,7 @@ def flush(self):
records to the target, if there is one. Override if you want
different behaviour.
The record buffer is also cleared by this operation.
The record buffer is only cleared if a target has been set.
"""
self.acquire()
try:
Expand Down

0 comments on commit 9875b17

Please sign in to comment.