summaryrefslogtreecommitdiffstats
path: root/Doc/howto
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2019-07-01 11:41:21 (GMT)
committerGitHub <noreply@github.com>2019-07-01 11:41:21 (GMT)
commit84de34e39eb9e49b2ae691c6f67df8d7da3561de (patch)
treee85fce4db616ce1392ef37a287b68319b8d1eb04 /Doc/howto
parent4a2edc34a405150d0b23ecfdcb401e7cf59f4650 (diff)
downloadcpython-84de34e39eb9e49b2ae691c6f67df8d7da3561de.zip
cpython-84de34e39eb9e49b2ae691c6f67df8d7da3561de.tar.gz
cpython-84de34e39eb9e49b2ae691c6f67df8d7da3561de.tar.bz2
bpo-32934: Clarified meaning of 'capacity' for BufferingHandler and MemoryHandler. (GH-14498)
Diffstat (limited to 'Doc/howto')
-rw-r--r--Doc/howto/logging-cookbook.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/howto/logging-cookbook.rst b/Doc/howto/logging-cookbook.rst
index 71f9fc9..87ac79e 100644
--- a/Doc/howto/logging-cookbook.rst
+++ b/Doc/howto/logging-cookbook.rst
@@ -2266,9 +2266,9 @@ The script just arranges to decorate ``foo`` with a decorator which will do the
conditional logging that's required. The decorator takes a logger as a parameter
and attaches a memory handler for the duration of the call to the decorated
function. The decorator can be additionally parameterised using a target handler,
-a level at which flushing should occur, and a capacity for the buffer. These
-default to a :class:`~logging.StreamHandler` which writes to ``sys.stderr``,
-``logging.ERROR`` and ``100`` respectively.
+a level at which flushing should occur, and a capacity for the buffer (number of
+records buffered). These default to a :class:`~logging.StreamHandler` which
+writes to ``sys.stderr``, ``logging.ERROR`` and ``100`` respectively.
Here's the script::