From: Éric Araujo Date: Thu, 1 Sep 2011 01:19:30 +0000 (+0200) Subject: Fix some misuses of Sphinx roles and one typo X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=43ba3545991691403d1b4ec1d04e66053c2ddf36;p=python Fix some misuses of Sphinx roles and one typo --- diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst index 4b70ec29a4..94f8c05ea6 100644 --- a/Doc/c-api/init.rst +++ b/Doc/c-api/init.rst @@ -122,7 +122,7 @@ Process-wide parameters program name is ``'/usr/local/bin/python'``, the prefix is ``'/usr/local'``. The returned string points into static storage; the caller should not modify its value. This corresponds to the :makevar:`prefix` variable in the top-level - :file:`Makefile` and the :option:`--prefix` argument to the :program:`configure` + :file:`Makefile` and the ``--prefix`` argument to the :program:`configure` script at build time. The value is available to Python code as ``sys.prefix``. It is only useful on Unix. See also the next function. @@ -135,7 +135,7 @@ Process-wide parameters program name is ``'/usr/local/bin/python'``, the exec-prefix is ``'/usr/local'``. The returned string points into static storage; the caller should not modify its value. This corresponds to the :makevar:`exec_prefix` - variable in the top-level :file:`Makefile` and the :option:`--exec-prefix` + variable in the top-level :file:`Makefile` and the ``--exec-prefix`` argument to the :program:`configure` script at build time. The value is available to Python code as ``sys.exec_prefix``. It is only useful on Unix. diff --git a/Doc/faq/design.rst b/Doc/faq/design.rst index b9faf576bf..02417b1e90 100644 --- a/Doc/faq/design.rst +++ b/Doc/faq/design.rst @@ -667,7 +667,7 @@ construction of large programs. Python 2.6 adds an :mod:`abc` module that lets you define Abstract Base Classes (ABCs). You can then use :func:`isinstance` and :func:`issubclass` to check whether an instance or a class implements a particular ABC. The -:mod:`collections` modules defines a set of useful ABCs such as +:mod:`collections` module defines a set of useful ABCs such as :class:`Iterable`, :class:`Container`, and :class:`MutableMapping`. For Python, many of the advantages of interface specifications can be obtained diff --git a/Doc/faq/windows.rst b/Doc/faq/windows.rst index 8a20950773..6b37faf9b5 100644 --- a/Doc/faq/windows.rst +++ b/Doc/faq/windows.rst @@ -546,7 +546,7 @@ A trick to get it to run an arbitrary file is to construct a call to :func:`execfile` with the name of your file as argument. Also note that you can not mix-and-match Debug and Release versions. If you -wish to use the Debug Multithreaded DLL, then your module *must* have an "_d" +wish to use the Debug Multithreaded DLL, then your module *must* have ``_d`` appended to the base name. diff --git a/Doc/howto/logging.rst b/Doc/howto/logging.rst index a7d6024a77..5ff0d74f6f 100644 --- a/Doc/howto/logging.rst +++ b/Doc/howto/logging.rst @@ -412,10 +412,10 @@ With the logger object configured, the following methods create log messages: :meth:`Logger.error`, and :meth:`Logger.critical` all create log records with a message and a level that corresponds to their respective method names. The message is actually a format string, which may contain the standard string - substitution syntax of :const:`%s`, :const:`%d`, :const:`%f`, and so on. The + substitution syntax of ``%s``, ``%d``, ``%f``, and so on. The rest of their arguments is a list of objects that correspond with the - substitution fields in the message. With regard to :const:`**kwargs`, the - logging methods care only about a keyword of :const:`exc_info` and use it to + substitution fields in the message. With regard to ``**kwargs``, the + logging methods care only about a keyword of ``exc_info`` and use it to determine whether to log exception information. * :meth:`Logger.exception` creates a log message similar to diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index 8d602fed11..f1287298c4 100644 --- a/Doc/library/argparse.rst +++ b/Doc/library/argparse.rst @@ -155,7 +155,7 @@ ArgumentParser objects conflicting optionals. * prog_ - The name of the program (default: - :data:`sys.argv[0]`) + ``sys.argv[0]``) * usage_ - The string describing the program usage (default: generated)