cpython: ed1dbac90b92 (original) (raw)

Mercurial > cpython

changeset 92609:ed1dbac90b92

Issue #22251: Fix ReST markup to avoid errors building docs. [#22251]

Berker Peksag berker.peksag@gmail.com
date	Sat, 27 Sep 2014 23:22:35 +0300
parents	8a56d87b81ef(current diff)0ec56e677bc3(diff)
children	ea665bae2ea0
files	Doc/library/argparse.rst Doc/library/asyncio-eventloop.rst Doc/library/logging.handlers.rst Doc/library/multiprocessing.rst Doc/library/os.rst Doc/library/pathlib.rst Doc/library/ssl.rst
diffstat	18 files changed, 38 insertions(+), 6 deletions(-)[+] [-] Doc/extending/newtypes.rst 2 Doc/faq/library.rst 4 Doc/library/argparse.rst 1 Doc/library/asyncio-eventloop.rst 4 Doc/library/asyncio-protocol.rst 2 Doc/library/asyncio-task.rst 1 Doc/library/email.contentmanager.rst 4 Doc/library/logging.handlers.rst 4 Doc/library/multiprocessing.rst 1 Doc/library/os.rst 1 Doc/library/pathlib.rst 3 Doc/library/pickle.rst 1 Doc/library/ssl.rst 3 Doc/library/statistics.rst 4 Doc/library/stdtypes.rst 1 Doc/library/sys.rst 1 Doc/library/warnings.rst 1 Doc/using/cmdline.rst 6

line wrap: on

line diff

--- a/Doc/extending/newtypes.rst +++ b/Doc/extending/newtypes.rst @@ -983,6 +983,7 @@ done. This can be done using the :c:fun } .. note:: + There are limitations to what you can safely do in a deallocator function. First, if your type supports garbage collection (using :c:member:~PyTypeObject.tp_traverse and/or :c:member:~PyTypeObject.tp_clear), some of the object's members can have been @@ -997,6 +998,7 @@ done. This can be done using the :c:fun :c:member:~PyTypeObject.tp_finalize type method. .. seealso:: + :pep:442 explains the new finalization scheme. .. index::

--- a/Doc/faq/library.rst +++ b/Doc/faq/library.rst @@ -697,7 +697,9 @@ quoted using :func:urllib.parse.urlenco[](#l2.3) >>> urllib.parse.urlencode({'name': 'Guy Steele, Jr.'})[](#l2.4) 'name=Guy+Steele%2C+Jr.'[](#l2.5) [](#l2.6) -.. seealso:: :ref:urllib-howto` for extensive examples. +.. seealso:: +

:ref:urllib-howto for extensive examples.

What module should I use to help with generating HTML?

--- a/Doc/library/argparse.rst +++ b/Doc/library/argparse.rst @@ -1894,6 +1894,7 @@ the populated namespace and the list of (Namespace(bar='BAR', foo=True), ['--badger', 'spam']) .. warning:: + :ref:Prefix matching <prefix-matching> rules apply to :meth:parse_known_args. The parser may consume an option even if it's just a prefix of one of its known options, instead of leaving it in the remaining

--- a/Doc/library/asyncio-eventloop.rst +++ b/Doc/library/asyncio-eventloop.rst @@ -197,7 +197,9 @@ Creating connections the transport; if ssl is :const:True, a context with some unspecified default settings is used.

.. seealso:: :ref:`SSL/TLS security considerations <ssl-security>`[](#l4.7)

```
.. seealso::[](#l4.8)
```

   :ref:`SSL/TLS security considerations <ssl-security>`[](#l4.10)

* server_hostname, is only for use together with ssl, and sets or overrides the hostname that the target server's certificate

--- a/Doc/library/asyncio-protocol.rst +++ b/Doc/library/asyncio-protocol.rst @@ -407,6 +407,7 @@ even more), and eventually :meth:resume[](#l5.3) buffer size reaches the low-water mark.[](#l5.4) [](#l5.5) .. note::[](#l5.6) +[](#l5.7) If the buffer size equals the high-water mark,[](#l5.8) :meth:pause_writing is not called -- it must go strictly over.[](#l5.9) Conversely, :meth:resume_writing is called when the buffer size is[](#l5.10) @@ -415,6 +416,7 @@ buffer size reaches the low-water mark.[](#l5.11) mark is zero.[](#l5.12) [](#l5.13) .. note::[](#l5.14) +[](#l5.15) On BSD systems (OS X, FreeBSD, etc.) flow control is not supported[](#l5.16) for :class:DatagramProtocol`, because send failures caused by writing too many packets cannot be detected easily. The socket

--- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -269,6 +269,7 @@ and it stores the result into the future the future. .. note:: + The :meth:~BaseEventLoop.run_until_complete method uses internally the :meth:~Future.add_done_callback method to be notified when the future is done.

--- a/Doc/library/email.contentmanager.rst +++ b/Doc/library/email.contentmanager.rst @@ -405,7 +405,9 @@ Currently the email package provides onl message/rfc822, use 8bit if cte is not specified. For all other values of subtype, use 7bit.

  .. note:: A *cte* of ``binary`` does not actually work correctly yet.[](#l7.7)

```
  .. note::[](#l7.8)
```

     A *cte* of ``binary`` does not actually work correctly yet.[](#l7.10)
     The ``Message`` object as modified by ``set_content`` is correct, but[](#l7.11)
     :class:`~email.generator.BytesGenerator` does not serialize it[](#l7.12)
     correctly.[](#l7.13)

--- a/Doc/library/logging.handlers.rst +++ b/Doc/library/logging.handlers.rst @@ -864,7 +864,9 @@ supports sending logging messages to a W :meth:mapLogRecord method is used to convert the record to the dictionary to be sent.

.. note:: Since preparing a record for sending it to a Web server is not

.. note:: +

 Since preparing a record for sending it to a Web server is not[](#l8.10)
 the same as a generic formatting operation, using[](#l8.11)
 :meth:`~logging.Handler.setFormatter` to specify a[](#l8.12)
 :class:`~logging.Formatter` for a :class:`HTTPHandler` has no effect.[](#l8.13)

--- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -851,6 +851,7 @@ Miscellaneous :exc:NotImplementedError. .. seealso:: + :func:os.cpu_count .. function:: current_process()

--- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -57,6 +57,7 @@ Notes on the availability of these funct 'ce', 'java'. .. seealso:: + :attr:sys.platform has a finer granularity. :func:os.uname gives system-dependent version information.

--- a/Doc/library/pathlib.rst +++ b/Doc/library/pathlib.rst @@ -32,15 +32,18 @@ Pure paths are useful in some special ca useful since those simply don't have any OS-accessing operations. .. note:: + This module has been included in the standard library on a :term:provisional basis <provisional package>. Backwards incompatible changes (up to and including removal of the package) may occur if deemed necessary by the core developers. .. seealso:: + :pep:428: The pathlib module -- object-oriented filesystem paths. .. seealso:: + For low-level path manipulation on strings, you can also use the :mod:os.path module.

--- a/Doc/library/pickle.rst +++ b/Doc/library/pickle.rst @@ -141,6 +141,7 @@ to read the pickle produced. brought by protocol 4. .. note:: + Serialization is a more primitive notion than persistence; although :mod:pickle reads and writes file objects, it does not handle the issue of naming persistent objects, nor the (even more complicated) issue of concurrent

--- a/Doc/library/ssl.rst +++ b/Doc/library/ssl.rst @@ -259,6 +259,7 @@ purposes. default CA certificates. .. note:: + The protocol, options, cipher and other settings may change to more restrictive values anytime without prior deprecation. The values represent a fair balance between compatibility and security. @@ -267,6 +268,7 @@ purposes. :class:SSLContext and apply the settings yourself. .. note:: + If you find that when certain older clients or servers attempt to connect with a :class:SSLContext created by this function that they get an error stating "Protocol or cipher suite mismatch", it may be that they @@ -963,6 +965,7 @@ to speed up repeated connections from th interoperability. .. seealso:: + :func:create_default_context lets the :mod:ssl module choose security settings for a given purpose.

--- a/Doc/library/statistics.rst +++ b/Doc/library/statistics.rst @@ -135,7 +135,9 @@ However, for reading convenience, most o This is suited for when your data is discrete, and you don't mind that the median may not be an actual data point.

.. seealso:: :func:median_low, :func:median_high, :func:median_grouped

.. seealso:: +

 :func:`median_low`, :func:`median_high`, :func:`median_grouped`[](#l14.10)

.. function:: median_low(data)

--- a/Doc/library/stdtypes.rst +++ b/Doc/library/stdtypes.rst @@ -3872,6 +3872,7 @@ pairs within braces, for example: ``{'ja :ref:documentation of view objects <dict-views>. .. seealso:: + :class:types.MappingProxyType can be used to create a read-only view of a :class:dict.

--- a/Doc/library/sys.rst +++ b/Doc/library/sys.rst @@ -798,6 +798,7 @@ always available. .. seealso:: + Module :mod:site This describes how to use .pth files to extend :data:sys.path.

--- a/Doc/library/warnings.rst +++ b/Doc/library/warnings.rst @@ -41,6 +41,7 @@ message by calling :func:formatwarning custom implementations. .. seealso:: + :func:logging.captureWarnings allows you to handle all warnings with the standard logging infrastructure.

--- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -107,6 +107,7 @@ source. python -mtimeit -h # for details .. seealso:: + :func:runpy.run_module Equivalent functionality directly available to Python code @@ -158,7 +159,9 @@ automatically enabled, if available on y .. versionchanged:: 3.4 Automatic enabling of tab-completion and history editing. -.. seealso:: :ref:tut-invoking +.. seealso:: +

:ref:tut-invoking

Generic options @@ -362,6 +365,7 @@ Miscellaneous options thus equivalent to an omitted line number. .. seealso:: + :mod:warnings -- the warnings module :pep:230 -- Warning framework