From 6b4c847c4f299517ec991621710c02459d204f05 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Thu, 30 Oct 2014 22:26:26 +0100 Subject: [PATCH] Doc: fix default role usage (except in unittest mock docs) --- Doc/distutils/examples.rst | 10 +++++----- Doc/howto/pyporting.rst | 2 +- Doc/library/ctypes.rst | 2 +- Doc/library/multiprocessing.rst | 8 ++++---- Doc/library/pickle.rst | 2 +- Doc/library/poplib.rst | 2 +- Doc/library/sys.rst | 2 +- Doc/library/test.rst | 6 +++--- Doc/library/xmlrpc.server.rst | 4 ++-- Doc/tutorial/inputoutput.rst | 4 ++-- Doc/whatsnew/3.0.rst | 2 +- Doc/whatsnew/3.3.rst | 2 +- 12 files changed, 23 insertions(+), 23 deletions(-) diff --git a/Doc/distutils/examples.rst b/Doc/distutils/examples.rst index b08e023859f..2ca76a096e8 100644 --- a/Doc/distutils/examples.rst +++ b/Doc/distutils/examples.rst @@ -286,20 +286,20 @@ Reading the metadata The :func:`distutils.core.setup` function provides a command-line interface that allows you to query the metadata fields of a project through the -`setup.py` script of a given project:: +``setup.py`` script of a given project:: $ python setup.py --name distribute -This call reads the `name` metadata by running the +This call reads the ``name`` metadata by running the :func:`distutils.core.setup` function. Although, when a source or binary distribution is created with Distutils, the metadata fields are written in a static file called :file:`PKG-INFO`. When a Distutils-based project is installed in Python, the :file:`PKG-INFO` file is copied alongside the modules and packages of the distribution under :file:`NAME-VERSION-pyX.X.egg-info`, -where `NAME` is the name of the project, `VERSION` its version as defined -in the Metadata, and `pyX.X` the major and minor version of Python like -`2.7` or `3.2`. +where ``NAME`` is the name of the project, ``VERSION`` its version as defined +in the Metadata, and ``pyX.X`` the major and minor version of Python like +``2.7`` or ``3.2``. You can read back this static file, by using the :class:`distutils.dist.DistributionMetadata` class and its diff --git a/Doc/howto/pyporting.rst b/Doc/howto/pyporting.rst index e1a460991a7..483dcae6869 100644 --- a/Doc/howto/pyporting.rst +++ b/Doc/howto/pyporting.rst @@ -535,7 +535,7 @@ Update ``map`` for imbalanced input sequences ''''''''''''''''''''''''''''''''''''''''''''' With Python 2, when ``map`` was given more than one input sequence it would pad -the shorter sequences with `None` values, returning a sequence as long as the +the shorter sequences with ``None`` values, returning a sequence as long as the longest input sequence. With Python 3, if the input sequences to ``map`` are of unequal length, ``map`` diff --git a/Doc/library/ctypes.rst b/Doc/library/ctypes.rst index aff42531ac6..8a859527a7b 100644 --- a/Doc/library/ctypes.rst +++ b/Doc/library/ctypes.rst @@ -1032,7 +1032,7 @@ As we can easily check, our array is sorted now:: outside of Python's control (e.g. by the foreign code that calls the callback), ctypes creates a new dummy Python thread on every invocation. This behavior is correct for most purposes, but it means that values stored with - `threading.local` will *not* survive across different callbacks, even when + :class:`threading.local` will *not* survive across different callbacks, even when those calls are made from the same C thread. .. _ctypes-accessing-values-exported-from-dlls: diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index e22755611b2..dc0370aa371 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -1962,18 +1962,18 @@ with the :class:`Pool` class. .. method:: starmap(func, iterable[, chunksize]) - Like :meth:`map` except that the elements of the `iterable` are expected + Like :meth:`map` except that the elements of the *iterable* are expected to be iterables that are unpacked as arguments. - Hence an `iterable` of `[(1,2), (3, 4)]` results in `[func(1,2), - func(3,4)]`. + Hence an *iterable* of ``[(1,2), (3, 4)]`` results in ``[func(1,2), + func(3,4)]``. .. versionadded:: 3.3 .. method:: starmap_async(func, iterable[, chunksize[, callback[, error_back]]]) A combination of :meth:`starmap` and :meth:`map_async` that iterates over - `iterable` of iterables and calls `func` with the iterables unpacked. + *iterable* of iterables and calls *func* with the iterables unpacked. Returns a result object. .. versionadded:: 3.3 diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst index ce5467fcf5e..47356f9f0cf 100644 --- a/Doc/library/pickle.rst +++ b/Doc/library/pickle.rst @@ -504,7 +504,7 @@ methods: .. method:: object.__getnewargs__() This method serve a similar purpose as :meth:`__getnewargs_ex__` but - for protocols 2 and newer. It must return a tuple of arguments `args` + for protocols 2 and newer. It must return a tuple of arguments ``args`` which will be passed to the :meth:`__new__` method upon unpickling. In protocols 4 and newer, :meth:`__getnewargs__` will not be called if diff --git a/Doc/library/poplib.rst b/Doc/library/poplib.rst index bc7b3e7d3a6..45baad96afa 100644 --- a/Doc/library/poplib.rst +++ b/Doc/library/poplib.rst @@ -15,7 +15,7 @@ This module defines a class, :class:`POP3`, which encapsulates a connection to a POP3 server and implements the protocol as defined in :rfc:`1939`. The :class:`POP3` class supports both the minimal and optional command sets from -:rfc:`1939`. The :class:`POP3` class also supports the `STLS` command introduced +:rfc:`1939`. The :class:`POP3` class also supports the ``STLS`` command introduced in :rfc:`2595` to enable encrypted communication on an already established connection. Additionally, this module provides a class :class:`POP3_SSL`, which provides diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst index bee309ec521..3024086a22a 100644 --- a/Doc/library/sys.rst +++ b/Doc/library/sys.rst @@ -667,7 +667,7 @@ always available. an underscore, and are not described here. Regardless of its contents, :data:`sys.implementation` will not change during a run of the interpreter, nor between implementation versions. (It may change between Python - language versions, however.) See `PEP 421` for more information. + language versions, however.) See :pep:`421` for more information. .. versionadded:: 3.3 diff --git a/Doc/library/test.rst b/Doc/library/test.rst index 7a7182a1cbc..974909e1820 100644 --- a/Doc/library/test.rst +++ b/Doc/library/test.rst @@ -85,7 +85,7 @@ A basic boilerplate is often used:: This code pattern allows the testing suite to be run by :mod:`test.regrtest`, on its own as a script that supports the :mod:`unittest` CLI, or via the -`python -m unittest` CLI. +``python -m unittest`` CLI. The goal for regression testing is to try to break code. This leads to a few guidelines to be followed: @@ -141,9 +141,9 @@ guidelines to be followed: arg = (1, 2, 3) When using this pattern, remember that all classes that inherit from - `unittest.TestCase` are run as tests. The `Mixin` class in the example above + :class:`unittest.TestCase` are run as tests. The :class:`Mixin` class in the example above does not have any data and so can't be run by itself, thus it does not - inherit from `unittest.TestCase`. + inherit from :class:`unittest.TestCase`. .. seealso:: diff --git a/Doc/library/xmlrpc.server.rst b/Doc/library/xmlrpc.server.rst index aca4f366bb2..37d1393eff0 100644 --- a/Doc/library/xmlrpc.server.rst +++ b/Doc/library/xmlrpc.server.rst @@ -184,8 +184,8 @@ server:: # Print list of available methods print(s.system.listMethods()) -The following example included in `Lib/xmlrpc/server.py` module shows a server -allowing dotted names and registering a multicall function. +The following example included in the :file:`Lib/xmlrpc/server.py` module shows +a server allowing dotted names and registering a multicall function. .. warning:: diff --git a/Doc/tutorial/inputoutput.rst b/Doc/tutorial/inputoutput.rst index b3bf0ef195f..6f9c99daf9b 100644 --- a/Doc/tutorial/inputoutput.rst +++ b/Doc/tutorial/inputoutput.rst @@ -323,8 +323,8 @@ first:: 18 ``f.tell()`` returns an integer giving the file object's current position in the file -represented as number of bytes from the beginning of the file when in `binary mode` and -an opaque number when in `text mode`. +represented as number of bytes from the beginning of the file when in binary mode and +an opaque number when in text mode. To change the file object's position, use ``f.seek(offset, from_what)``. The position is computed from adding *offset* to a reference point; the reference point is selected by diff --git a/Doc/whatsnew/3.0.rst b/Doc/whatsnew/3.0.rst index 71b87b827e9..99411305a59 100644 --- a/Doc/whatsnew/3.0.rst +++ b/Doc/whatsnew/3.0.rst @@ -164,7 +164,7 @@ Some well-known APIs no longer return lists: If the input sequences are not of equal length, :func:`map` will stop at the termination of the shortest of the sequences. For full - compatibility with `map` from Python 2.x, also wrap the sequences in + compatibility with :func:`map` from Python 2.x, also wrap the sequences in :func:`itertools.zip_longest`, e.g. ``map(func, *sequences)`` becomes ``list(map(func, itertools.zip_longest(*sequences)))``. diff --git a/Doc/whatsnew/3.3.rst b/Doc/whatsnew/3.3.rst index 2e29d8579ba..b0e217a809b 100644 --- a/Doc/whatsnew/3.3.rst +++ b/Doc/whatsnew/3.3.rst @@ -2080,7 +2080,7 @@ Add a new :class:`types.MappingProxyType` class: Read-only proxy of a mapping. (:issue:`14386`) -The new functions `types.new_class` and `types.prepare_class` provide support +The new functions :func:`types.new_class` and :func:`types.prepare_class` provide support for PEP 3115 compliant dynamic type creation. (:issue:`14588`)