Commit a22bdd62 authored by Serhiy Storchaka's avatar Serhiy Storchaka

Issue #19795: Improved more markups of True/False.

parent 4124a0be
...@@ -278,5 +278,5 @@ Number Protocol ...@@ -278,5 +278,5 @@ Number Protocol
.. c:function:: int PyIndex_Check(PyObject *o) .. c:function:: int PyIndex_Check(PyObject *o)
Returns True if *o* is an index integer (has the nb_index slot of the Returns ``1`` if *o* is an index integer (has the nb_index slot of the
tp_as_number structure filled in). tp_as_number structure filled in), and ``0`` otherwise.
...@@ -346,7 +346,7 @@ Creating connections ...@@ -346,7 +346,7 @@ Creating connections
* *reuse_address* tells the kernel to reuse a local socket in * *reuse_address* tells the kernel to reuse a local socket in
TIME_WAIT state, without waiting for its natural timeout to TIME_WAIT state, without waiting for its natural timeout to
expire. If not specified will automatically be set to True on expire. If not specified will automatically be set to ``True`` on
UNIX. UNIX.
* *reuse_port* tells the kernel to allow this endpoint to be bound to the * *reuse_port* tells the kernel to allow this endpoint to be bound to the
...@@ -424,7 +424,7 @@ Creating listening connections ...@@ -424,7 +424,7 @@ Creating listening connections
* *reuse_address* tells the kernel to reuse a local socket in * *reuse_address* tells the kernel to reuse a local socket in
TIME_WAIT state, without waiting for its natural timeout to TIME_WAIT state, without waiting for its natural timeout to
expire. If not specified will automatically be set to True on expire. If not specified will automatically be set to ``True`` on
UNIX. UNIX.
* *reuse_port* tells the kernel to allow this endpoint to be bound to the * *reuse_port* tells the kernel to allow this endpoint to be bound to the
......
...@@ -245,7 +245,7 @@ Future ...@@ -245,7 +245,7 @@ Future
.. method:: done() .. method:: done()
Return True if the future is done. Return ``True`` if the future is done.
Done means either that a result / exception are available, or that the Done means either that a result / exception are available, or that the
future was cancelled. future was cancelled.
...@@ -562,7 +562,7 @@ Task functions ...@@ -562,7 +562,7 @@ Task functions
All futures must share the same event loop. If all the tasks are done All futures must share the same event loop. If all the tasks are done
successfully, the returned future's result is the list of results (in the successfully, the returned future's result is the list of results (in the
order of the original sequence, not necessarily the order of results order of the original sequence, not necessarily the order of results
arrival). If *return_exceptions* is True, exceptions in the tasks are arrival). If *return_exceptions* is true, exceptions in the tasks are
treated the same as successful results, and gathered in the result list; treated the same as successful results, and gathered in the result list;
otherwise, the first raised exception will be immediately propagated to the otherwise, the first raised exception will be immediately propagated to the
returned future. returned future.
......
...@@ -1358,7 +1358,7 @@ details, consult the :manpage:`dlopen(3)` manpage. On Windows, *mode* is ...@@ -1358,7 +1358,7 @@ details, consult the :manpage:`dlopen(3)` manpage. On Windows, *mode* is
ignored. On posix systems, RTLD_NOW is always added, and is not ignored. On posix systems, RTLD_NOW is always added, and is not
configurable. configurable.
The *use_errno* parameter, when set to True, enables a ctypes mechanism that The *use_errno* parameter, when set to true, enables a ctypes mechanism that
allows accessing the system :data:`errno` error number in a safe way. allows accessing the system :data:`errno` error number in a safe way.
:mod:`ctypes` maintains a thread-local copy of the systems :data:`errno` :mod:`ctypes` maintains a thread-local copy of the systems :data:`errno`
variable; if you call foreign functions created with ``use_errno=True`` then the variable; if you call foreign functions created with ``use_errno=True`` then the
...@@ -1369,7 +1369,7 @@ The function :func:`ctypes.get_errno` returns the value of the ctypes private ...@@ -1369,7 +1369,7 @@ The function :func:`ctypes.get_errno` returns the value of the ctypes private
copy, and the function :func:`ctypes.set_errno` changes the ctypes private copy copy, and the function :func:`ctypes.set_errno` changes the ctypes private copy
to a new value and returns the former value. to a new value and returns the former value.
The *use_last_error* parameter, when set to True, enables the same mechanism for The *use_last_error* parameter, when set to true, enables the same mechanism for
the Windows error code which is managed by the :func:`GetLastError` and the Windows error code which is managed by the :func:`GetLastError` and
:func:`SetLastError` Windows API functions; :func:`ctypes.get_last_error` and :func:`SetLastError` Windows API functions; :func:`ctypes.get_last_error` and
:func:`ctypes.set_last_error` are used to request and change the ctypes private :func:`ctypes.set_last_error` are used to request and change the ctypes private
...@@ -1579,7 +1579,7 @@ type and the argument types of the function. ...@@ -1579,7 +1579,7 @@ type and the argument types of the function.
The returned function prototype creates functions that use the standard C The returned function prototype creates functions that use the standard C
calling convention. The function will release the GIL during the call. If calling convention. The function will release the GIL during the call. If
*use_errno* is set to True, the ctypes private copy of the system *use_errno* is set to true, the ctypes private copy of the system
:data:`errno` variable is exchanged with the real :data:`errno` value before :data:`errno` variable is exchanged with the real :data:`errno` value before
and after the call; *use_last_error* does the same for the Windows error and after the call; *use_last_error* does the same for the Windows error
code. code.
......
...@@ -56,7 +56,7 @@ The :mod:`functools` module defines the following functions: ...@@ -56,7 +56,7 @@ The :mod:`functools` module defines the following functions:
grow without bound. The LRU feature performs best when *maxsize* is a grow without bound. The LRU feature performs best when *maxsize* is a
power-of-two. power-of-two.
If *typed* is set to True, function arguments of different types will be If *typed* is set to true, function arguments of different types will be
cached separately. For example, ``f(3)`` and ``f(3.0)`` will be treated cached separately. For example, ``f(3)`` and ``f(3.0)`` will be treated
as distinct calls with distinct results. as distinct calls with distinct results.
......
...@@ -537,7 +537,7 @@ Raw File I/O ...@@ -537,7 +537,7 @@ Raw File I/O
The *name* can be one of two things: The *name* can be one of two things:
* a character string or :class:`bytes` object representing the path to the * a character string or :class:`bytes` object representing the path to the
file which will be opened. In this case closefd must be True (the default) file which will be opened. In this case closefd must be ``True`` (the default)
otherwise an error will be raised. otherwise an error will be raised.
* an integer representing the number of an existing OS-level file descriptor * an integer representing the number of an existing OS-level file descriptor
to which the resulting :class:`FileIO` object will give access. When the to which the resulting :class:`FileIO` object will give access. When the
......
...@@ -318,7 +318,7 @@ is the module's name in the Python package namespace. ...@@ -318,7 +318,7 @@ is the module's name in the Python package namespace.
looking for handlers in this logger and its parents in the logger hierarchy. looking for handlers in this logger and its parents in the logger hierarchy.
Returns ``True`` if a handler was found, else ``False``. The method stops searching Returns ``True`` if a handler was found, else ``False``. The method stops searching
up the hierarchy whenever a logger with the 'propagate' attribute set to up the hierarchy whenever a logger with the 'propagate' attribute set to
False is found - that will be the last logger which is checked for the false is found - that will be the last logger which is checked for the
existence of handlers. existence of handlers.
.. versionadded:: 3.2 .. versionadded:: 3.2
......
...@@ -52,7 +52,7 @@ sending a graphics file. ...@@ -52,7 +52,7 @@ sending a graphics file.
Like :func:`encode`, except that it accepts a source :class:`bytes` and Like :func:`encode`, except that it accepts a source :class:`bytes` and
returns the corresponding encoded :class:`bytes`. By default, it sends a returns the corresponding encoded :class:`bytes`. By default, it sends a
False value to *quotetabs* parameter of the :func:`encode` function. ``False`` value to *quotetabs* parameter of the :func:`encode` function.
......
...@@ -1387,7 +1387,7 @@ to speed up repeated connections from the same clients. ...@@ -1387,7 +1387,7 @@ to speed up repeated connections from the same clients.
This setting doesn't apply to client sockets. You can also use the This setting doesn't apply to client sockets. You can also use the
:data:`OP_SINGLE_ECDH_USE` option to further improve security. :data:`OP_SINGLE_ECDH_USE` option to further improve security.
This method is not available if :data:`HAS_ECDH` is False. This method is not available if :data:`HAS_ECDH` is ``False``.
.. versionadded:: 3.3 .. versionadded:: 3.3
......
...@@ -64,7 +64,7 @@ compatibility with older versions, see the :ref:`call-function-trio` section. ...@@ -64,7 +64,7 @@ compatibility with older versions, see the :ref:`call-function-trio` section.
is automatically created with ``stdin=PIPE``, and the *stdin* argument may is automatically created with ``stdin=PIPE``, and the *stdin* argument may
not be used as well. not be used as well.
If *check* is True, and the process exits with a non-zero exit code, a If *check* is true, and the process exits with a non-zero exit code, a
:exc:`CalledProcessError` exception will be raised. Attributes of that :exc:`CalledProcessError` exception will be raised. Attributes of that
exception hold the arguments, the exit code, and stdout and stderr if they exception hold the arguments, the exit code, and stdout and stderr if they
were captured. were captured.
......
...@@ -152,7 +152,7 @@ identifier. Python currently uses eight paths: ...@@ -152,7 +152,7 @@ identifier. Python currently uses eight paths:
If *vars* is provided, it must be a dictionary of variables that will If *vars* is provided, it must be a dictionary of variables that will
update the dictionary used to expand the paths. update the dictionary used to expand the paths.
If *expand* is set to False, the paths will not be expanded. If *expand* is set to false, the paths will not be expanded.
If *scheme* is not an existing scheme, :func:`get_paths` will raise a If *scheme* is not an existing scheme, :func:`get_paths` will raise a
:exc:`KeyError`. :exc:`KeyError`.
......
...@@ -615,7 +615,7 @@ item to the buffer only needs to wake up one consumer thread. ...@@ -615,7 +615,7 @@ item to the buffer only needs to wake up one consumer thread.
.. method:: wait_for(predicate, timeout=None) .. method:: wait_for(predicate, timeout=None)
Wait until a condition evaluates to True. *predicate* should be a Wait until a condition evaluates to true. *predicate* should be a
callable which result will be interpreted as a boolean value. callable which result will be interpreted as a boolean value.
A *timeout* may be provided giving the maximum time to wait. A *timeout* may be provided giving the maximum time to wait.
......
...@@ -245,8 +245,8 @@ Deleting an entry and reinserting it will move it to the end:: ...@@ -245,8 +245,8 @@ Deleting an entry and reinserting it will move it to the end::
[('first', 1), ('third', 3), ('second', 5)] [('first', 1), ('third', 3), ('second', 5)]
The :meth:`~collections.OrderedDict.popitem` method has an optional *last* The :meth:`~collections.OrderedDict.popitem` method has an optional *last*
argument that defaults to True. If *last* is True, the most recently argument that defaults to ``True``. If *last* is true, the most recently
added key is returned and removed; if it's False, the added key is returned and removed; if it's false, the
oldest key is selected:: oldest key is selected::
>>> od = OrderedDict([(x,0) for x in range(20)]) >>> od = OrderedDict([(x,0) for x in range(20)])
...@@ -1518,7 +1518,7 @@ changes, or look through the Subversion logs for all the details. ...@@ -1518,7 +1518,7 @@ changes, or look through the Subversion logs for all the details.
* The :mod:`SocketServer` module's :class:`~SocketServer.TCPServer` class now * The :mod:`SocketServer` module's :class:`~SocketServer.TCPServer` class now
supports socket timeouts and disabling the Nagle algorithm. supports socket timeouts and disabling the Nagle algorithm.
The :attr:`~SocketServer.TCPServer.disable_nagle_algorithm` class attribute The :attr:`~SocketServer.TCPServer.disable_nagle_algorithm` class attribute
defaults to False; if overridden to be True, defaults to ``False``; if overridden to be true,
new request connections will have the TCP_NODELAY option set to new request connections will have the TCP_NODELAY option set to
prevent buffering many small sends into a single TCP packet. prevent buffering many small sends into a single TCP packet.
The :attr:`~SocketServer.BaseServer.timeout` class attribute can hold The :attr:`~SocketServer.BaseServer.timeout` class attribute can hold
...@@ -1879,7 +1879,7 @@ The error messages for :meth:`~unittest.TestCase.assertEqual`, ...@@ -1879,7 +1879,7 @@ The error messages for :meth:`~unittest.TestCase.assertEqual`,
:meth:`~unittest.TestCase.assertTrue`, and :meth:`~unittest.TestCase.assertFalse` :meth:`~unittest.TestCase.assertTrue`, and :meth:`~unittest.TestCase.assertFalse`
failures now provide more information. If you set the failures now provide more information. If you set the
:attr:`~unittest.TestCase.longMessage` attribute of your :class:`~unittest.TestCase` classes to :attr:`~unittest.TestCase.longMessage` attribute of your :class:`~unittest.TestCase` classes to
True, both the standard error message and any additional message you true, both the standard error message and any additional message you
provide will be printed for failures. (Added by Michael Foord; :issue:`5663`.) provide will be printed for failures. (Added by Michael Foord; :issue:`5663`.)
The :meth:`~unittest.TestCase.assertRaises` method now The :meth:`~unittest.TestCase.assertRaises` method now
...@@ -1986,7 +1986,7 @@ GvR worked on merging them into Python's version of :mod:`unittest`. ...@@ -1986,7 +1986,7 @@ GvR worked on merging them into Python's version of :mod:`unittest`.
sequence comparison methods do. sequence comparison methods do.
:func:`unittest.main` now takes an optional ``exit`` argument. If :func:`unittest.main` now takes an optional ``exit`` argument. If
False, :func:`~unittest.main` doesn't call :func:`sys.exit`, allowing false, :func:`~unittest.main` doesn't call :func:`sys.exit`, allowing
:func:`~unittest.main` to be used from the interactive interpreter. :func:`~unittest.main` to be used from the interactive interpreter.
(Contributed by J. Pablo Fernández; :issue:`3379`.) (Contributed by J. Pablo Fernández; :issue:`3379`.)
......
...@@ -1742,7 +1742,7 @@ sched ...@@ -1742,7 +1742,7 @@ sched
----- -----
* :meth:`~sched.scheduler.run` now accepts a *blocking* parameter which when * :meth:`~sched.scheduler.run` now accepts a *blocking* parameter which when
set to False makes the method execute the scheduled events due to expire set to false makes the method execute the scheduled events due to expire
soonest (if any) and then return immediately. soonest (if any) and then return immediately.
This is useful in case you want to use the :class:`~sched.scheduler` in This is useful in case you want to use the :class:`~sched.scheduler` in
non-blocking applications. (Contributed by Giampaolo Rodolà in :issue:`13449`.) non-blocking applications. (Contributed by Giampaolo Rodolà in :issue:`13449`.)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment