summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2013-08-16 23:39:42 (GMT)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>2013-08-16 23:39:42 (GMT)
commit67f39777fa2c14f0e632adda8c5945cec569b46e (patch)
treebc5ef888b645c06d6b238e39ff084df01e790221 /Doc/library
parenta3811e4b8f70790a3dc8768a455cb8836670de37 (diff)
downloadcpython-67f39777fa2c14f0e632adda8c5945cec569b46e.zip
cpython-67f39777fa2c14f0e632adda8c5945cec569b46e.tar.gz
cpython-67f39777fa2c14f0e632adda8c5945cec569b46e.tar.bz2
Issue #18759: Improved cross-references in logging documentation.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/logging.config.rst14
-rw-r--r--Doc/library/logging.handlers.rst14
2 files changed, 16 insertions, 12 deletions
diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index 1391ed2..e34e010 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -101,8 +101,9 @@ in :mod:`logging` itself) and defining handlers which are declared either in
configurations. If no port is specified, the module's default
:const:`DEFAULT_LOGGING_CONFIG_PORT` is used. Logging configurations will be
sent as a file suitable for processing by :func:`fileConfig`. Returns a
- :class:`Thread` instance on which you can call :meth:`start` to start the
- server, and which you can :meth:`join` when appropriate. To stop the server,
+ :class:`~threading.Thread` instance on which you can call
+ :meth:`~threading.Thread.start` to start the server, and which you can
+ :meth:`~threading.Thread.join` when appropriate. To stop the server,
call :func:`stopListening`.
To send a configuration to the socket, read in the configuration file and
@@ -166,11 +167,11 @@ otherwise, the context is used to determine what to instantiate.
* *formatters* - the corresponding value will be a dict in which each
key is a formatter id and each value is a dict describing how to
- configure the corresponding Formatter instance.
+ configure the corresponding :class:`~logging.Formatter` instance.
The configuring dict is searched for keys ``format`` and ``datefmt``
(with defaults of ``None``) and these are used to construct a
- :class:`logging.Formatter` instance.
+ :class:`~logging.Formatter` instance.
* *filters* - the corresponding value will be a dict in which each key
is a filter id and each value is a dict describing how to configure
@@ -704,8 +705,9 @@ format string, with a comma separator. An example time in ISO8601 format is
The ``class`` entry is optional. It indicates the name of the formatter's class
(as a dotted module and class name.) This option is useful for instantiating a
-:class:`Formatter` subclass. Subclasses of :class:`Formatter` can present
-exception tracebacks in an expanded or condensed format.
+:class:`~logging.Formatter` subclass. Subclasses of
+:class:`~logging.Formatter` can present exception tracebacks in an expanded or
+condensed format.
.. note:: Due to the use of :func:`eval` as described above, there are
potential security risks which result from using the :func:`listen` to send
diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst
index 30f9e03..0855050 100644
--- a/Doc/library/logging.handlers.rst
+++ b/Doc/library/logging.handlers.rst
@@ -53,8 +53,8 @@ and :meth:`flush` methods).
.. method:: flush()
Flushes the stream by calling its :meth:`flush` method. Note that the
- :meth:`close` method is inherited from :class:`Handler` and so does
- no output, so an explicit :meth:`flush` call may be needed at times.
+ :meth:`close` method is inherited from :class:`~logging.Handler` and so
+ does no output, so an explicit :meth:`flush` call may be needed at times.
.. versionchanged:: 3.2
The ``StreamHandler`` class now has a ``terminator`` attribute, default
@@ -145,8 +145,8 @@ new stream.
This handler is not appropriate for use under Windows, because under Windows
open log files cannot be moved or renamed - logging opens the files with
exclusive locks - and so there is no need for such a handler. Furthermore,
-*ST_INO* is not supported under Windows; :func:`stat` always returns zero for
-this value.
+*ST_INO* is not supported under Windows; :func:`~os.stat` always returns zero
+for this value.
.. class:: WatchedFileHandler(filename[,mode[, encoding[, delay]]])
@@ -383,7 +383,8 @@ sends logging output to a network socket. The base class uses a TCP socket.
binary format. If there is an error with the socket, silently drops the
packet. If the connection was previously lost, re-establishes the
connection. To unpickle the record at the receiving end into a
- :class:`LogRecord`, use the :func:`makeLogRecord` function.
+ :class:`~logging.LogRecord`, use the :func:`~logging.makeLogRecord`
+ function.
.. method:: handleError()
@@ -461,7 +462,8 @@ over UDP sockets.
Pickles the record's attribute dictionary and writes it to the socket in
binary format. If there is an error with the socket, silently drops the
packet. To unpickle the record at the receiving end into a
- :class:`LogRecord`, use the :func:`makeLogRecord` function.
+ :class:`~logging.LogRecord`, use the :func:`~logging.makeLogRecord`
+ function.
.. method:: makeSocket()