summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2014-03-24 08:06:18 (GMT)
committerGeorg Brandl <georg@python.org>2014-03-24 08:06:18 (GMT)
commitdf48b97855b378a13d852656d358ca92ecbe4aa3 (patch)
tree3075e47c89a79974038451d9e65cd59c7f533396 /Doc
parent645d3b76559d3c85cc90d2c8787fa6c765327e71 (diff)
downloadcpython-df48b97855b378a13d852656d358ca92ecbe4aa3.zip
cpython-df48b97855b378a13d852656d358ca92ecbe4aa3.tar.gz
cpython-df48b97855b378a13d852656d358ca92ecbe4aa3.tar.bz2
Fix a few scoping issues with versionadded/versionchanged directives.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/exceptions.rst8
-rw-r--r--Doc/c-api/object.rst1
-rw-r--r--Doc/library/doctest.rst3
-rw-r--r--Doc/library/faulthandler.rst4
-rw-r--r--Doc/library/functions.rst1
-rw-r--r--Doc/library/imaplib.rst1
-rw-r--r--Doc/library/imp.rst30
-rw-r--r--Doc/library/importlib.rst4
-rw-r--r--Doc/library/multiprocessing.rst4
-rw-r--r--Doc/library/optparse.rst4
-rw-r--r--Doc/library/sys.rst3
-rw-r--r--Doc/library/urllib.request.rst7
12 files changed, 38 insertions, 32 deletions
diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index 7067448..6fda191 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -247,7 +247,7 @@ in various ways. There is a separate error indicator for each thread.
filename object, for raising errors when a function that takes two filenames
fails.
-.. versionadded:: 3.4
+ .. versionadded:: 3.4
.. c:function:: PyObject* PyErr_SetFromErrnoWithFilename(PyObject *type, const char *filename)
@@ -295,7 +295,7 @@ in various ways. There is a separate error indicator for each thread.
but accepts a second filename object.
Availability: Windows.
-.. versionadded:: 3.4
+ .. versionadded:: 3.4
.. c:function:: PyObject* PyErr_SetExcFromWindowsErrWithFilename(PyObject *type, int ierr, const char *filename)
@@ -321,7 +321,7 @@ in various ways. There is a separate error indicator for each thread.
attributes, which make the exception printing subsystem think the exception
is a :exc:`SyntaxError`.
-.. versionadded:: 3.4
+ .. versionadded:: 3.4
.. c:function:: void PyErr_SyntaxLocationEx(char *filename, int lineno, int col_offset)
@@ -329,7 +329,7 @@ in various ways. There is a separate error indicator for each thread.
Like :c:func:`PyErr_SyntaxLocationObject`, but *filename* is a byte string
decoded from the filesystem encoding (:func:`os.fsdecode`).
-.. versionadded:: 3.2
+ .. versionadded:: 3.2
.. c:function:: void PyErr_SyntaxLocation(char *filename, int lineno)
diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst
index 509ca3f..3e7c3b6 100644
--- a/Doc/c-api/object.rst
+++ b/Doc/c-api/object.rst
@@ -364,6 +364,7 @@ attribute is considered sufficient for this determination.
.. versionadded:: 3.4
+
.. c:function:: PyObject* PyObject_GetItem(PyObject *o, PyObject *key)
Return element of *o* corresponding to the object *key* or *NULL* on failure.
diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst
index 28df49c..50626e9 100644
--- a/Doc/library/doctest.rst
+++ b/Doc/library/doctest.rst
@@ -502,7 +502,8 @@ or'ed together and passed to various functions. The names can also be used in
:ref:`doctest directives <doctest-directives>`, and may be passed to the
doctest command line interface via the ``-o`` option.
-.. versionadded:: 3.4 the ``-o`` command line option
+.. versionadded:: 3.4
+ The ``-o`` command line option.
The first group of options define test semantics, controlling aspects of how
doctest decides whether actual output matches an example's expected output:
diff --git a/Doc/library/faulthandler.rst b/Doc/library/faulthandler.rst
index 61bc503..fb9ccf3 100644
--- a/Doc/library/faulthandler.rst
+++ b/Doc/library/faulthandler.rst
@@ -4,6 +4,8 @@
.. module:: faulthandler
:synopsis: Dump the Python traceback.
+.. versionadded:: 3.3
+
This module contains functions to dump Python tracebacks explicitly, on a fault,
after a timeout, or on a user signal. Call :func:`faulthandler.enable` to
install fault handlers for the :const:`SIGSEGV`, :const:`SIGFPE`,
@@ -36,8 +38,6 @@ alternatively be passed to :func:`faulthandler.enable`.
The module is implemented in C, so tracebacks can be dumped on a crash or when
Python is deadlocked.
-.. versionadded:: 3.3
-
Dump the traceback
------------------
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 2b37069..9a8c9d7 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -832,6 +832,7 @@ are always available. They are listed here in alphabetical order.
.. versionadded:: 3.4
The *default* keyword-only argument.
+
.. function:: next(iterator[, default])
Retrieve the next item from the *iterator* by calling its
diff --git a/Doc/library/imaplib.rst b/Doc/library/imaplib.rst
index 39f6919..fa736fe 100644
--- a/Doc/library/imaplib.rst
+++ b/Doc/library/imaplib.rst
@@ -451,6 +451,7 @@ An :class:`IMAP4` instance has the following methods:
:attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see
:data:`ssl.HAS_SNI`).
+
.. method:: IMAP4.status(mailbox, names)
Request named status conditions for *mailbox*.
diff --git a/Doc/library/imp.rst b/Doc/library/imp.rst
index 8f0b79f..ed4820e 100644
--- a/Doc/library/imp.rst
+++ b/Doc/library/imp.rst
@@ -262,12 +262,12 @@ that circular imports work without any deadlocks.
exception is made for circular imports, which by construction have to
expose an incomplete module object at some point.
-.. versionchanged:: 3.3
- The locking scheme has changed to per-module locks for
- the most part. A global import lock is kept for some critical tasks,
- such as initializing the per-module locks.
+ .. versionchanged:: 3.3
+ The locking scheme has changed to per-module locks for
+ the most part. A global import lock is kept for some critical tasks,
+ such as initializing the per-module locks.
-.. deprecated:: 3.4
+ .. deprecated:: 3.4
.. function:: acquire_lock()
@@ -282,12 +282,12 @@ that circular imports work without any deadlocks.
On platforms without threads, this function does nothing.
-.. versionchanged:: 3.3
- The locking scheme has changed to per-module locks for
- the most part. A global import lock is kept for some critical tasks,
- such as initializing the per-module locks.
+ .. versionchanged:: 3.3
+ The locking scheme has changed to per-module locks for
+ the most part. A global import lock is kept for some critical tasks,
+ such as initializing the per-module locks.
-.. deprecated:: 3.4
+ .. deprecated:: 3.4
.. function:: release_lock()
@@ -295,12 +295,12 @@ that circular imports work without any deadlocks.
Release the interpreter's global import lock. On platforms without
threads, this function does nothing.
-.. versionchanged:: 3.3
- The locking scheme has changed to per-module locks for
- the most part. A global import lock is kept for some critical tasks,
- such as initializing the per-module locks.
+ .. versionchanged:: 3.3
+ The locking scheme has changed to per-module locks for
+ the most part. A global import lock is kept for some critical tasks,
+ such as initializing the per-module locks.
-.. deprecated:: 3.4
+ .. deprecated:: 3.4
The following constants with integer values, defined in this module, are used
diff --git a/Doc/library/importlib.rst b/Doc/library/importlib.rst
index 3b55b06..f3b2063 100644
--- a/Doc/library/importlib.rst
+++ b/Doc/library/importlib.rst
@@ -626,8 +626,8 @@ ABC hierarchy::
have to implement it, but it is still available for compatibility
purposes. Raise :exc:`IOError` if the path cannot be handled.
- .. versionchanged:: 3.4
- Raise :exc:`IOError` instead of :exc:`NotImplementedError`.
+ .. versionchanged:: 3.4
+ Raise :exc:`IOError` instead of :exc:`NotImplementedError`.
.. method:: set_data(path, data)
diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index b303e16..5fac730 100644
--- a/Doc/library/multiprocessing.rst
+++ b/Doc/library/multiprocessing.rst
@@ -138,9 +138,9 @@ to start a process. These *start methods* are
.. versionchanged:: 3.4
*spawn* added on all unix platforms, and *forkserver* added for
- some unix platforms.
+ some unix platforms.
Child processes no longer inherit all of the parents inheritable
- handles on Windows.
+ handles on Windows.
On Unix using the *spawn* or *forkserver* start methods will also
start a *semaphore tracker* process which tracks the unlinked named
diff --git a/Doc/library/optparse.rst b/Doc/library/optparse.rst
index 13395b6..72145aa 100644
--- a/Doc/library/optparse.rst
+++ b/Doc/library/optparse.rst
@@ -8,8 +8,8 @@
.. sectionauthor:: Greg Ward <gward@python.net>
.. deprecated:: 3.2
- The :mod:`optparse` module is deprecated and will not be developed further;
- development will continue with the :mod:`argparse` module.
+ The :mod:`optparse` module is deprecated and will not be developed further;
+ development will continue with the :mod:`argparse` module.
**Source code:** :source:`Lib/optparse.py`
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index 7dc1d78..2328a10 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -12,11 +12,12 @@ always available.
.. data:: abiflags
- On POSIX systems where Python is build with the standard ``configure``
+ On POSIX systems where Python was built with the standard ``configure``
script, this contains the ABI flags as specified by :pep:`3149`.
.. versionadded:: 3.2
+
.. data:: argv
The list of command line arguments passed to a Python script. ``argv[0]`` is the
diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst
index 6ac9081..019f59c 100644
--- a/Doc/library/urllib.request.rst
+++ b/Doc/library/urllib.request.rst
@@ -523,9 +523,10 @@ request.
Return a list of tuples (header_name, header_value) of the Request headers.
.. versionchanged:: 3.4
- Request methods add_data, has_data, get_data, get_type, get_host,
- get_selector, get_origin_req_host and is_unverifiable deprecated since 3.3
- have been removed.
+ The request methods add_data, has_data, get_data, get_type, get_host,
+ get_selector, get_origin_req_host and is_unverifiable that were deprecated
+ since 3.3 have been removed.
+
.. _opener-director-objects: