summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2010-12-19 13:41:26 (GMT)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>2010-12-19 13:41:26 (GMT)
commit01094e1fe4893b0563f9b14537e487b6538233d6 (patch)
treed16bdc4068a1b0b8337d29b5556c40999cb16eb9 /Doc
parentc63619bcf286128b6d870aadc1991b1e39ac7b01 (diff)
downloadcpython-01094e1fe4893b0563f9b14537e487b6538233d6.zip
cpython-01094e1fe4893b0563f9b14537e487b6538233d6.tar.gz
cpython-01094e1fe4893b0563f9b14537e487b6538233d6.tar.bz2
Logging documentation updates.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/logging.config.rst10
-rw-r--r--Doc/library/logging.handlers.rst14
-rw-r--r--Doc/library/logging.rst7
3 files changed, 26 insertions, 5 deletions
diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index 399d4dc..3a05439 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 a2e1be8..810a473 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 4eb39d4..e02556b 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.