From: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Date: Sun, 19 Dec 2010 13:41:26 +0000 (+0000)
Subject: Logging documentation updates.
X-Git-Tag: v3.2rc1~391
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=01094e1fe4893b0563f9b14537e487b6538233d6;p=python

Logging documentation updates.
---

diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index 399d4dcc53..3a05439226 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -8,6 +8,16 @@
 .. moduleauthor:: 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:
 
diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst
index a2e1be8441..810a473350 100644
--- a/Doc/library/logging.handlers.rst
+++ b/Doc/library/logging.handlers.rst
@@ -8,10 +8,22 @@
 .. moduleauthor:: 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
 
+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
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index 4eb39d47f1..e02556b8d6 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -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 @@ modules.
 
 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.