Commit 7422ebb8 authored by Vinay Sajip's avatar Vinay Sajip

Issue #16884: Updated docs to use 'note' directives.

parent ad11f5d5
...@@ -757,13 +757,14 @@ should have the desired effect. If an organisation produces a number of ...@@ -757,13 +757,14 @@ should have the desired effect. If an organisation produces a number of
libraries, then the logger name specified can be 'orgname.foo' rather than libraries, then the logger name specified can be 'orgname.foo' rather than
just 'foo'. just 'foo'.
**PLEASE NOTE:** It is strongly advised that you *do not add any handlers other .. note:: It is strongly advised that you *do not add any handlers other
than* :class:`~logging.NullHandler` *to your library's loggers*. This is than* :class:`~logging.NullHandler` *to your library's loggers*. This is
because the configuration of handlers is the prerogative of the application because the configuration of handlers is the prerogative of the application
developer who uses your library. The application developer knows their target developer who uses your library. The application developer knows their
audience and what handlers are most appropriate for their application: if you target audience and what handlers are most appropriate for their
add handlers 'under the hood', you might well interfere with their ability to application: if you add handlers 'under the hood', you might well interfere
carry out unit tests and deliver logs which suit their requirements. with their ability to carry out unit tests and deliver logs which suit their
requirements.
Logging Levels Logging Levels
...@@ -940,10 +941,10 @@ The default implementation of :meth:`handleError` in :class:`Handler` checks ...@@ -940,10 +941,10 @@ The default implementation of :meth:`handleError` in :class:`Handler` checks
to see if a module-level variable, :data:`raiseExceptions`, is set. If set, a to see if a module-level variable, :data:`raiseExceptions`, is set. If set, a
traceback is printed to :data:`sys.stderr`. If not set, the exception is swallowed. traceback is printed to :data:`sys.stderr`. If not set, the exception is swallowed.
**Note:** The default value of :data:`raiseExceptions` is ``True``. This is because .. note:: The default value of :data:`raiseExceptions` is ``True``. This is
during development, you typically want to be notified of any exceptions that because during development, you typically want to be notified of any
occur. It's advised that you set :data:`raiseExceptions` to ``False`` for production exceptions that occur. It's advised that you set :data:`raiseExceptions` to
usage. ``False`` for production usage.
.. currentmodule:: logging .. currentmodule:: logging
......
...@@ -800,14 +800,14 @@ functions. ...@@ -800,14 +800,14 @@ functions.
Logs a message with level *level* on the root logger. The other arguments are Logs a message with level *level* on the root logger. The other arguments are
interpreted as for :func:`debug`. interpreted as for :func:`debug`.
PLEASE NOTE: The above module-level functions which delegate to the root .. note:: The above module-level functions which delegate to the root
logger should *not* be used in threads, in versions of Python earlier than logger should *not* be used in threads, in versions of Python earlier
2.7.1 and 3.2, unless at least one handler has been added to the root than 2.7.1 and 3.2, unless at least one handler has been added to the
logger *before* the threads are started. These convenience functions call root logger *before* the threads are started. These convenience functions
:func:`basicConfig` to ensure that at least one handler is available; in call :func:`basicConfig` to ensure that at least one handler is
earlier versions of Python, this can (under rare circumstances) lead to available; in earlier versions of Python, this can (under rare
handlers being added multiple times to the root logger, which can in turn circumstances) lead to handlers being added multiple times to the root
lead to multiple messages for the same event. logger, which can in turn lead to multiple messages for the same event.
.. function:: disable(lvl) .. function:: disable(lvl)
...@@ -830,8 +830,8 @@ functions. ...@@ -830,8 +830,8 @@ functions.
registered using this function, levels should be positive integers and they registered using this function, levels should be positive integers and they
should increase in increasing order of severity. should increase in increasing order of severity.
NOTE: If you are thinking of defining your own levels, please see the section .. note:: If you are thinking of defining your own levels, please see the
on :ref:`custom-levels`. section on :ref:`custom-levels`.
.. function:: getLevelName(lvl) .. function:: getLevelName(lvl)
...@@ -866,12 +866,12 @@ functions. ...@@ -866,12 +866,12 @@ functions.
.. versionchanged:: 2.4 .. versionchanged:: 2.4
Formerly, :func:`basicConfig` did not take any keyword arguments. Formerly, :func:`basicConfig` did not take any keyword arguments.
PLEASE NOTE: This function should be called from the main thread .. note:: This function should be called from the main thread before other
before other threads are started. In versions of Python prior to threads are started. In versions of Python prior to 2.7.1 and 3.2, if
2.7.1 and 3.2, if this function is called from multiple threads, this function is called from multiple threads, it is possible (in rare
it is possible (in rare circumstances) that a handler will be added circumstances) that a handler will be added to the root logger more than
to the root logger more than once, leading to unexpected results once, leading to unexpected results such as messages being duplicated in
such as messages being duplicated in the log. the log.
The following keyword arguments are supported. The following keyword arguments are supported.
......
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