[Python-checkins] gh-107028: tiny textual changes in logging docs and docstrings (GH-107029)
vsajip
webhook-mailer at python.org
Sat Jul 22 16:43:22 EDT 2023
https://github.com/python/cpython/commit/5e5a34ac3a827e040cd89426b1774fec2123336a
commit: 5e5a34ac3a827e040cd89426b1774fec2123336a
branch: main
author: Jochem Boersma <jochem.boersma at witteveenbos.com>
committer: vsajip <vinay_sajip at yahoo.co.uk>
date: 2023-07-22T21:43:18+01:00
summary:
gh-107028: tiny textual changes in logging docs and docstrings (GH-107029)
files:
M Doc/library/logging.handlers.rst
M Lib/logging/handlers.py
diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst
index 47bfe4ff7f90e..72e5ffb3a1218 100644
--- a/Doc/library/logging.handlers.rst
+++ b/Doc/library/logging.handlers.rst
@@ -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)
@@ -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)
diff --git a/Lib/logging/handlers.py b/Lib/logging/handlers.py
index 9847104446eaf..671cc9596b02d 100644
--- a/Lib/logging/handlers.py
+++ b/Lib/logging/handlers.py
@@ -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:
More information about the Python-checkins
mailing list