mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 02:39:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

Logging documentation updates.

Browse source
This commit is contained in:
Vinay Sajip 2010-12-19 13:41:26 +00:00
parent c63619bcf2
commit 01094e1fe4
3 changed files with 26 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Doc/library/logging.config.rst
View file

@ -8,6 +8,16 @@
.. moduleauthor:: Vinay Sajip <vinay_sajip@red-dove.com> .. moduleauthor:: Vinay Sajip <vinay_sajip@red-dove.com>
.. sectionauthor:: Vinay Sajip <vinay_sajip@red-dove.com> .. sectionauthor:: Vinay Sajip <vinay_sajip@red-dove.com>
.. sidebar:: Important
This page contains only reference information. For tutorials,
please see
* :ref:`Basic Tutorial <logging-basic-tutorial>`
* :ref:`Advanced Tutorial <logging-advanced-tutorial>`
* :ref:`Logging Cookbook <logging-cookbook>`
This section describes the API for configuring the logging module.
.. _logging-config-api: .. _logging-config-api:

14
Doc/library/logging.handlers.rst
View file

@ -8,10 +8,22 @@
.. moduleauthor:: Vinay Sajip <vinay_sajip@red-dove.com> .. moduleauthor:: Vinay Sajip <vinay_sajip@red-dove.com>
.. sectionauthor:: Vinay Sajip <vinay_sajip@red-dove.com> .. sectionauthor:: Vinay Sajip <vinay_sajip@red-dove.com>
The following useful handlers are provided in the package. .. sidebar:: Important
This page contains only reference information. For tutorials,
please see
* :ref:`Basic Tutorial <logging-basic-tutorial>`
* :ref:`Advanced Tutorial <logging-advanced-tutorial>`
* :ref:`Logging Cookbook <logging-cookbook>`
.. currentmodule:: logging .. currentmodule:: logging
The following useful handlers are provided in the package. Note that three of
the handlers (:class:`StreamHandler`, :class:`FileHandler` and
:class:`NullHandler`) are actually defined in the :mod:`logging` module itself,
but have been documented here along with the other handlers.
.. _stream-handler: .. _stream-handler:
StreamHandler StreamHandler

7
Doc/library/logging.rst
View file

@ -13,14 +13,14 @@
.. sidebar:: Important .. sidebar:: Important
The tutorials have been moved to the HOWTO section: This page contains the API reference information. For tutorial
information and discussion of more advanced topics, see
* :ref:`Basic Tutorial <logging-basic-tutorial>` * :ref:`Basic Tutorial <logging-basic-tutorial>`
* :ref:`Advanced Tutorial <logging-advanced-tutorial>` * :ref:`Advanced Tutorial <logging-advanced-tutorial>`
* :ref:`Logging Cookbook <logging-cookbook>` * :ref:`Logging Cookbook <logging-cookbook>`
This module defines functions and classes which implement a flexible event This module defines functions and classes which implement a flexible event
logging system for applications and libraries. logging system for applications and libraries.
@ -31,8 +31,7 @@ modules.
The module provides a lot of functionality and flexibility. If you are The module provides a lot of functionality and flexibility. If you are
unfamiliar with logging, the best way to get to grips with it is to see the unfamiliar with logging, the best way to get to grips with it is to see the
tutorials (see the links on the right). This page contains the API reference tutorials (see the links on the right).
information.
The basic classes defined by the module, together with their functions, are The basic classes defined by the module, together with their functions, are
listed below. listed below.