Commit 30bf1228 authored by Vinay Sajip's avatar Vinay Sajip

Corrected minor typo and added .currentmodule directives to fix missing cross-references.

parent 44e3bb6a
...@@ -119,7 +119,7 @@ Another useful feature of the logging API is the ability to produce different ...@@ -119,7 +119,7 @@ Another useful feature of the logging API is the ability to produce different
messages at different log levels. This allows you to instrument your code with messages at different log levels. This allows you to instrument your code with
debug messages, for example, but turning the log level down so that those debug debug messages, for example, but turning the log level down so that those debug
messages are not written for your production system. The default levels are messages are not written for your production system. The default levels are
``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO``, ``DEBUG`` and ``UNSET``. ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO``, ``DEBUG`` and ``NOTSET``.
The logger, handler, and log message call each specify a level. The log message The logger, handler, and log message call each specify a level. The log message
is only emitted if the handler and logger are configured to emit messages of is only emitted if the handler and logger are configured to emit messages of
...@@ -421,6 +421,7 @@ code approach, mainly separation of configuration and code and the ability of ...@@ -421,6 +421,7 @@ code approach, mainly separation of configuration and code and the ability of
noncoders to easily modify the logging properties. noncoders to easily modify the logging properties.
.. _library-config: .. _library-config:
Configuring Logging for a Library Configuring Logging for a Library
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
...@@ -529,6 +530,8 @@ provided: ...@@ -529,6 +530,8 @@ provided:
#. :class:`FileHandler` instances send error messages to disk files. #. :class:`FileHandler` instances send error messages to disk files.
.. currentmodule:: logging.handlers
#. :class:`BaseRotatingHandler` is the base class for handlers that rotate log #. :class:`BaseRotatingHandler` is the base class for handlers that rotate log
files at a certain point. It is not meant to be instantiated directly. Instead, files at a certain point. It is not meant to be instantiated directly. Instead,
use :class:`RotatingFileHandler` or :class:`TimedRotatingFileHandler`. use :class:`RotatingFileHandler` or :class:`TimedRotatingFileHandler`.
...@@ -558,6 +561,13 @@ provided: ...@@ -558,6 +561,13 @@ provided:
#. :class:`HTTPHandler` instances send error messages to an HTTP server using #. :class:`HTTPHandler` instances send error messages to an HTTP server using
either ``GET`` or ``POST`` semantics. either ``GET`` or ``POST`` semantics.
#. :class:`WatchedFileHandler` instances watch the file they are logging to. If
the file changes, it is closed and reopened using the file name. This handler
is only useful on Unix-like systems; Windows does not support the underlying
mechanism used.
.. currentmodule:: logging
#. :class:`NullHandler` instances do nothing with error messages. They are used #. :class:`NullHandler` instances do nothing with error messages. They are used
by library developers who want to use logging, but want to avoid the "No by library developers who want to use logging, but want to avoid the "No
handlers could be found for logger XXX" message which can be displayed if handlers could be found for logger XXX" message which can be displayed if
...@@ -1618,8 +1628,6 @@ WatchedFileHandler ...@@ -1618,8 +1628,6 @@ WatchedFileHandler
.. module:: logging.handlers .. module:: logging.handlers
.. module:: logging.handlers
The :class:`WatchedFileHandler` class, located in the :mod:`logging.handlers` The :class:`WatchedFileHandler` class, located in the :mod:`logging.handlers`
module, is a :class:`FileHandler` which watches the file it is logging to. If module, is a :class:`FileHandler` which watches the file it is logging to. If
the file changes, it is closed and reopened using the file name. the file changes, it is closed and reopened using the file name.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment