From 9c1dba2758fc601f6c4d7fe2aeb62272ffd688a8 Mon Sep 17 00:00:00 2001 From: Berker Peksag Date: Sun, 28 Sep 2014 00:00:58 +0300 Subject: [PATCH] Revert #22251 --- 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 +----- 18 files changed, 6 insertions(+), 38 deletions(-) diff --git a/Doc/extending/newtypes.rst b/Doc/extending/newtypes.rst index 2dfcdc0f3177..45b57211b679 100644 --- a/Doc/extending/newtypes.rst +++ b/Doc/extending/newtypes.rst @@ -983,7 +983,6 @@ done. This can be done using the :c:func:`PyErr_Fetch` and } .. 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 @@ -998,7 +997,6 @@ done. This can be done using the :c:func:`PyErr_Fetch` and :c:member:`~PyTypeObject.tp_finalize` type method. .. seealso:: - :pep:`442` explains the new finalization scheme. .. index:: diff --git a/Doc/faq/library.rst b/Doc/faq/library.rst index a89eaa23a9e6..5f4ff1797b7b 100644 --- a/Doc/faq/library.rst +++ b/Doc/faq/library.rst @@ -697,9 +697,7 @@ quoted using :func:`urllib.parse.urlencode`. For example, to send >>> urllib.parse.urlencode({'name': 'Guy Steele, Jr.'}) 'name=Guy+Steele%2C+Jr.' -.. seealso:: - - :ref:`urllib-howto` for extensive examples. +.. seealso:: :ref:`urllib-howto` for extensive examples. What module should I use to help with generating HTML? diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index 9a3514c87e81..3260667647a3 100644 --- a/Doc/library/argparse.rst +++ b/Doc/library/argparse.rst @@ -1894,7 +1894,6 @@ the populated namespace and the list of remaining argument strings. (Namespace(bar='BAR', foo=True), ['--badger', 'spam']) .. warning:: - :ref:`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 diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst index cc848aab13d4..8706b41ff470 100644 --- a/Doc/library/asyncio-eventloop.rst +++ b/Doc/library/asyncio-eventloop.rst @@ -197,9 +197,7 @@ Creating connections the transport; if *ssl* is :const:`True`, a context with some unspecified default settings is used. - .. seealso:: - - :ref:`SSL/TLS security considerations ` + .. seealso:: :ref:`SSL/TLS security considerations ` * *server_hostname*, is only for use together with *ssl*, and sets or overrides the hostname that the target server's certificate diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst index 4299a2181934..92b055a7b567 100644 --- a/Doc/library/asyncio-protocol.rst +++ b/Doc/library/asyncio-protocol.rst @@ -407,7 +407,6 @@ even more), and eventually :meth:`resume_writing` is called once when the buffer size reaches the low-water mark. .. note:: - If the buffer size equals the high-water mark, :meth:`pause_writing` is not called -- it must go strictly over. Conversely, :meth:`resume_writing` is called when the buffer size is @@ -416,7 +415,6 @@ buffer size reaches the low-water mark. mark is zero. .. note:: - On BSD systems (OS X, FreeBSD, etc.) flow control is not supported for :class:`DatagramProtocol`, because send failures caused by writing too many packets cannot be detected easily. The socket diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 3223001f2d5e..e7c316df9e92 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -269,7 +269,6 @@ and it stores the result into the future. The 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. diff --git a/Doc/library/email.contentmanager.rst b/Doc/library/email.contentmanager.rst index ba2f5ea4b922..8f33a146dd87 100644 --- a/Doc/library/email.contentmanager.rst +++ b/Doc/library/email.contentmanager.rst @@ -405,9 +405,7 @@ Currently the email package provides only one concrete content manager, ``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. + .. note:: A *cte* of ``binary`` does not actually work correctly yet. The ``Message`` object as modified by ``set_content`` is correct, but :class:`~email.generator.BytesGenerator` does not serialize it correctly. diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst index 37678f018811..a2b14de1b013 100644 --- a/Doc/library/logging.handlers.rst +++ b/Doc/library/logging.handlers.rst @@ -864,9 +864,7 @@ supports sending logging messages to a Web server, using either ``GET`` or :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 the same as a generic formatting operation, using :meth:`~logging.Handler.setFormatter` to specify a :class:`~logging.Formatter` for a :class:`HTTPHandler` has no effect. diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index 1121f07c3418..e568e68faddb 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -851,7 +851,6 @@ Miscellaneous :exc:`NotImplementedError`. .. seealso:: - :func:`os.cpu_count` .. function:: current_process() diff --git a/Doc/library/os.rst b/Doc/library/os.rst index b9eaba0ccfaa..0a59108b2c08 100644 --- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -57,7 +57,6 @@ Notes on the availability of these functions: ``'ce'``, ``'java'``. .. seealso:: - :attr:`sys.platform` has a finer granularity. :func:`os.uname` gives system-dependent version information. diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst index ba0bcbf05faa..ec1dc4f6168c 100644 --- a/Doc/library/pathlib.rst +++ b/Doc/library/pathlib.rst @@ -32,18 +32,15 @@ Pure paths are useful in some special cases; for example: 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 `. 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. diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst index aceb68616d0e..ce5467fcf5e0 100644 --- a/Doc/library/pickle.rst +++ b/Doc/library/pickle.rst @@ -141,7 +141,6 @@ 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 diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst index 676e93710383..5ab6c14d8ed4 100644 --- a/Doc/library/ssl.rst +++ b/Doc/library/ssl.rst @@ -259,7 +259,6 @@ 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. @@ -268,7 +267,6 @@ 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 @@ -934,7 +932,6 @@ to speed up repeated connections from the same clients. interoperability. .. seealso:: - :func:`create_default_context` lets the :mod:`ssl` module choose security settings for a given purpose. diff --git a/Doc/library/statistics.rst b/Doc/library/statistics.rst index 7058e40faf34..4e7783872a46 100644 --- a/Doc/library/statistics.rst +++ b/Doc/library/statistics.rst @@ -135,9 +135,7 @@ However, for reading convenience, most of the examples show sorted sequences. 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` .. function:: median_low(data) diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst index fa715d307962..8778212cdb61 100644 --- a/Doc/library/stdtypes.rst +++ b/Doc/library/stdtypes.rst @@ -3872,7 +3872,6 @@ pairs within braces, for example: ``{'jack': 4098, 'sjoerd': 4127}`` or ``{4098: :ref:`documentation of view objects `. .. seealso:: - :class:`types.MappingProxyType` can be used to create a read-only view of a :class:`dict`. diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst index fe3dc75bb97d..bee309ec521d 100644 --- a/Doc/library/sys.rst +++ b/Doc/library/sys.rst @@ -798,7 +798,6 @@ always available. .. seealso:: - Module :mod:`site` This describes how to use .pth files to extend :data:`sys.path`. diff --git a/Doc/library/warnings.rst b/Doc/library/warnings.rst index 5ca833614edd..8a538adb9b02 100644 --- a/Doc/library/warnings.rst +++ b/Doc/library/warnings.rst @@ -41,7 +41,6 @@ message by calling :func:`formatwarning`, which is also available for use by custom implementations. .. seealso:: - :func:`logging.captureWarnings` allows you to handle all warnings with the standard logging infrastructure. diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst index 162b61316a25..55e0e678e926 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -107,7 +107,6 @@ source. python -mtimeit -h # for details .. seealso:: - :func:`runpy.run_module` Equivalent functionality directly available to Python code @@ -159,9 +158,7 @@ automatically enabled, if available on your platform (see .. versionchanged:: 3.4 Automatic enabling of tab-completion and history editing. -.. seealso:: - - :ref:`tut-invoking` +.. seealso:: :ref:`tut-invoking` Generic options @@ -365,7 +362,6 @@ Miscellaneous options thus equivalent to an omitted line number. .. seealso:: - :mod:`warnings` -- the warnings module :pep:`230` -- Warning framework -- 2.47.3