Skip to content

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

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
Dec 9, 2017
Merged

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

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
32 changes: 16 additions & 16 deletions Doc/library/logging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down