[Python-checkins] cpython: Avoid relying on the default reST role in logging library doc

eric.araujo python-checkins at python.org
Sat Oct 22 19:34:38 CEST 2011


http://hg.python.org/cpython/rev/5110d723fbb1
changeset:   73052:5110d723fbb1
user:        Éric Araujo <merwok at netwok.org>
date:        Sat Oct 22 19:29:48 2011 +0200
summary:
  Avoid relying on the default reST role in logging library doc

files:
  Doc/library/logging.rst |  20 ++++++++++----------
  1 files changed, 10 insertions(+), 10 deletions(-)


diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -137,7 +137,7 @@
 
        Stack (most recent call last):
 
-   This mimics the `Traceback (most recent call last):` which is used when
+   This mimics the ``Traceback (most recent call last):`` which is used when
    displaying exception frames.
 
    The third keyword argument is *extra* which can be used to pass a
@@ -189,9 +189,9 @@
    Logs a message with level :const:`WARNING` on this logger. The arguments are
    interpreted as for :meth:`debug`.
 
-   .. note:: There is an obsolete method `warn()` which is functionally
-      identical to `warning()`. As `warn()` is deprecated, please do not use
-      it - use `warning()` instead.
+   .. note:: There is an obsolete method ``warn`` which is functionally
+      identical to ``warning``. As ``warn`` is deprecated, please do not use
+      it - use ``warning`` instead.
 
 .. method:: Logger.error(msg, *args, **kwargs)
 
@@ -836,7 +836,7 @@
 
        Stack (most recent call last):
 
-   This mimics the `Traceback (most recent call last):` which is used when
+   This mimics the ``Traceback (most recent call last):`` which is used when
    displaying exception frames.
 
    The third optional keyword argument is *extra* which can be used to pass a
@@ -886,9 +886,9 @@
    Logs a message with level :const:`WARNING` on the root logger. The arguments
    are interpreted as for :func:`debug`.
 
-   .. note:: There is an obsolete function `warn()` which is functionally
-      identical to `warning()`. As `warn()` is deprecated, please do not use
-      it - use `warning()` instead.
+   .. note:: There is an obsolete function ``warn`` which is functionally
+      identical to ``warning``. As ``warn`` is deprecated, please do not use
+      it - use ``warning`` instead.
 
 
 .. function:: error(msg, *args, **kwargs)
@@ -1094,11 +1094,11 @@
    If *capture* is ``True``, warnings issued by the :mod:`warnings` module will
    be redirected to the logging system. Specifically, a warning will be
    formatted using :func:`warnings.formatwarning` and the resulting string
-   logged to a logger named 'py.warnings' with a severity of `WARNING`.
+   logged to a logger named ``'py.warnings'`` with a severity of ``'WARNING'``.
 
    If *capture* is ``False``, the redirection of warnings to the logging system
    will stop, and warnings will be redirected to their original destinations
-   (i.e. those in effect before `captureWarnings(True)` was called).
+   (i.e. those in effect before ``captureWarnings(True)`` was called).
 
 
 .. seealso::

-- 
Repository URL: http://hg.python.org/cpython


More information about the Python-checkins mailing list