[Python-checkins] bpo-32212: Updated logging documentation to make parameter names more consistent with source. (GH-4765) (GH-4768)

Vinay Sajip webhook-mailer at python.org
Sat Dec 9 07:49:15 EST 2017


https://github.com/python/cpython/commit/292fce9934280867ca9a65870495f83fca37751e
commit: 292fce9934280867ca9a65870495f83fca37751e
branch: 2.7
author: Vinay Sajip <vinay_sajip at yahoo.co.uk>
committer: GitHub <noreply at github.com>
date: 2017-12-09T12:49:10Z
summary:

bpo-32212: Updated logging documentation to make parameter names more consistent with source. (GH-4765) (GH-4768)

(cherry picked from commit a9f8df646aac7fc94ced0aefd1ed2c8566d14d10)

files:
M Doc/library/logging.rst

diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index ba2ab835fd4..0f568aaa976 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -95,10 +95,10 @@ is the module's name in the Python package namespace.
       scenario is to attach handlers only to the root logger, and to let
       propagation take care of the rest.
 
-.. method:: Logger.setLevel(lvl)
+.. method:: Logger.setLevel(level)
 
-   Sets the threshold for this logger to *lvl*. Logging messages which are less
-   severe than *lvl* will be ignored. When a logger is created, the level is set to
+   Sets the threshold for this logger to *level*. Logging messages which are less
+   severe than *level* will be ignored. When a logger is created, the level is set to
    :const:`NOTSET` (which causes all messages to be processed when the logger is
    the root logger, or delegation to the parent when the logger is a non-root
    logger). Note that the root logger is created with level :const:`WARNING`.
@@ -232,14 +232,14 @@ is the module's name in the Python package namespace.
    should only be called from an exception handler.
 
 
-.. method:: Logger.addFilter(filt)
+.. method:: Logger.addFilter(filter)
 
-   Adds the specified filter *filt* to this logger.
+   Adds the specified filter *filter* to this logger.
 
 
-.. method:: Logger.removeFilter(filt)
+.. method:: Logger.removeFilter(filter)
 
-   Removes the specified filter *filt* from this logger.
+   Removes the specified filter *filter* from this logger.
 
 
 .. method:: Logger.filter(record)
@@ -349,27 +349,27 @@ subclasses. However, the :meth:`__init__` method in subclasses needs to call
    Releases the thread lock acquired with :meth:`acquire`.
 
 
-.. method:: Handler.setLevel(lvl)
+.. method:: Handler.setLevel(level)
 
-   Sets the threshold for this handler to *lvl*. Logging messages which are less
-   severe than *lvl* will be ignored. When a handler is created, the level is set
+   Sets the threshold for this handler to *level*. Logging messages which are less
+   severe than *level* will be ignored. When a handler is created, the level is set
    to :const:`NOTSET` (which causes all messages to be processed).
 
    See :ref:`levels` for a list of levels.
 
-.. method:: Handler.setFormatter(form)
+.. method:: Handler.setFormatter(fmt)
 
-   Sets the :class:`Formatter` for this handler to *form*.
+   Sets the :class:`Formatter` for this handler to *fmt*.
 
 
-.. method:: Handler.addFilter(filt)
+.. method:: Handler.addFilter(filter)
 
-   Adds the specified filter *filt* to this handler.
+   Adds the specified filter *filter* to this handler.
 
 
-.. method:: Handler.removeFilter(filt)
+.. method:: Handler.removeFilter(filter)
 
-   Removes the specified filter *filt* from this handler.
+   Removes the specified filter *filter* from this handler.
 
 
 .. method:: Handler.filter(record)



More information about the Python-checkins mailing list