Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
3749404b
Commit
3749404b
authored
Sep 27, 2014
by
Berker Peksag
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Issue #22251: Fix ReST markup to avoid errors building docs.
parent
c5deed3a
Changes
18
Hide whitespace changes
Inline
Side-by-side
Showing
18 changed files
with
38 additions
and
6 deletions
+38
-6
Doc/extending/newtypes.rst
Doc/extending/newtypes.rst
+2
-0
Doc/faq/library.rst
Doc/faq/library.rst
+3
-1
Doc/library/argparse.rst
Doc/library/argparse.rst
+1
-0
Doc/library/asyncio-eventloop.rst
Doc/library/asyncio-eventloop.rst
+3
-1
Doc/library/asyncio-protocol.rst
Doc/library/asyncio-protocol.rst
+2
-0
Doc/library/asyncio-task.rst
Doc/library/asyncio-task.rst
+1
-0
Doc/library/email.contentmanager.rst
Doc/library/email.contentmanager.rst
+3
-1
Doc/library/logging.handlers.rst
Doc/library/logging.handlers.rst
+3
-1
Doc/library/multiprocessing.rst
Doc/library/multiprocessing.rst
+1
-0
Doc/library/os.rst
Doc/library/os.rst
+1
-0
Doc/library/pathlib.rst
Doc/library/pathlib.rst
+3
-0
Doc/library/pickle.rst
Doc/library/pickle.rst
+1
-0
Doc/library/ssl.rst
Doc/library/ssl.rst
+3
-0
Doc/library/statistics.rst
Doc/library/statistics.rst
+3
-1
Doc/library/stdtypes.rst
Doc/library/stdtypes.rst
+1
-0
Doc/library/sys.rst
Doc/library/sys.rst
+1
-0
Doc/library/warnings.rst
Doc/library/warnings.rst
+1
-0
Doc/using/cmdline.rst
Doc/using/cmdline.rst
+5
-1
No files found.
Doc/extending/newtypes.rst
View file @
3749404b
...
...
@@ -983,6 +983,7 @@ 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
...
...
@@ -997,6 +998,7 @@ 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::
...
...
Doc/faq/library.rst
View file @
3749404b
...
...
@@ -697,7 +697,9 @@ 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?
...
...
Doc/library/argparse.rst
View file @
3749404b
...
...
@@ -1894,6 +1894,7 @@ the populated namespace and the list of remaining argument strings.
(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
...
...
Doc/library/asyncio-eventloop.rst
View file @
3749404b
...
...
@@ -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>`
.. seealso::
:ref:`SSL/TLS security considerations <ssl-security>`
* *server_hostname*, is only for use together with *ssl*,
and sets or overrides the hostname that the target server's certificate
...
...
Doc/library/asyncio-protocol.rst
View file @
3749404b
...
...
@@ -407,6 +407,7 @@ 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
...
...
@@ -415,6 +416,7 @@ 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
...
...
Doc/library/asyncio-task.rst
View file @
3749404b
...
...
@@ -269,6 +269,7 @@ 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.
...
...
Doc/library/email.contentmanager.rst
View file @
3749404b
...
...
@@ -405,7 +405,9 @@ 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.
...
...
Doc/library/logging.handlers.rst
View file @
3749404b
...
...
@@ -864,7 +864,9 @@ 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.
...
...
Doc/library/multiprocessing.rst
View file @
3749404b
...
...
@@ -851,6 +851,7 @@ Miscellaneous
:
exc
:`
NotImplementedError
`.
..
seealso
::
:
func
:`
os
.
cpu_count
`
..
function
::
current_process
()
...
...
Doc/library/os.rst
View file @
3749404b
...
...
@@ -57,6 +57,7 @@ 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.
...
...
Doc/library/pathlib.rst
View file @
3749404b
...
...
@@ -32,15 +32,18 @@ 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 <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.
...
...
Doc/library/pickle.rst
View file @
3749404b
...
...
@@ -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
...
...
Doc/library/ssl.rst
View file @
3749404b
...
...
@@ -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
...
...
@@ -932,6 +934,7 @@ 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.
...
...
Doc/library/statistics.rst
View file @
3749404b
...
...
@@ -135,7 +135,9 @@ 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)
...
...
Doc/library/stdtypes.rst
View file @
3749404b
...
...
@@ -3872,6 +3872,7 @@ pairs within braces, for example: ``{'jack': 4098, 'sjoerd': 4127}`` or ``{4098:
:ref:`documentation of view objects <dict-views>`.
.. seealso::
:class:`types.MappingProxyType` can be used to create a read-only view
of a :class:`dict`.
...
...
Doc/library/sys.rst
View file @
3749404b
...
...
@@ -798,6 +798,7 @@ always available.
.. seealso::
Module :mod:`site` This describes how to use .pth files to extend
:data:`sys.path`.
...
...
Doc/library/warnings.rst
View file @
3749404b
...
...
@@ -41,6 +41,7 @@ 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.
...
...
Doc/using/cmdline.rst
View file @
3749404b
...
...
@@ -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 your platform (see
..
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
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment