[Python-checkins] r87403 - in python/branches/py3k/Doc/library: logging.config.rst logging.handlers.rst logging.rst

[vinay.sajip]

Author: vinay.sajip
Date: Sun Dec 19 14:41:26 2010
New Revision: 87403

Log:
Logging documentation updates.

Modified:
   python/branches/py3k/Doc/library/logging.config.rst
   python/branches/py3k/Doc/library/logging.handlers.rst
   python/branches/py3k/Doc/library/logging.rst

Modified: python/branches/py3k/Doc/library/logging.config.rst
==============================================================================
--- python/branches/py3k/Doc/library/logging.config.rst	(original)
+++ python/branches/py3k/Doc/library/logging.config.rst	Sun Dec 19 14:41:26 2010
@@ -8,6 +8,16 @@
 .. moduleauthor:: Vinay Sajip <vinay_sajip at red-dove.com>
 .. sectionauthor:: Vinay Sajip <vinay_sajip at 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:
 

Modified: python/branches/py3k/Doc/library/logging.handlers.rst
==============================================================================
--- python/branches/py3k/Doc/library/logging.handlers.rst	(original)
+++ python/branches/py3k/Doc/library/logging.handlers.rst	Sun Dec 19 14:41:26 2010
@@ -8,10 +8,22 @@
 .. moduleauthor:: Vinay Sajip <vinay_sajip at red-dove.com>
 .. sectionauthor:: Vinay Sajip <vinay_sajip at 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
 
+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:
 
 StreamHandler

Modified: python/branches/py3k/Doc/library/logging.rst
==============================================================================
--- python/branches/py3k/Doc/library/logging.rst	(original)
+++ python/branches/py3k/Doc/library/logging.rst	Sun Dec 19 14:41:26 2010
@@ -13,14 +13,14 @@
 
 .. 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:`Advanced Tutorial <logging-advanced-tutorial>`
    * :ref:`Logging Cookbook <logging-cookbook>`
 
 
-
 This module defines functions and classes which implement a flexible event
 logging system for applications and libraries.
 
@@ -31,8 +31,7 @@
 
 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
-tutorials (see the links on the right). This page contains the API reference
-information.
+tutorials (see the links on the right).
 
 The basic classes defined by the module, together with their functions, are
 listed below.