8000 [doc] Fix erroneous backslashes in signatures and names by andresdelfino · Pull Request #23658 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

[doc] Fix erroneous backslashes in signatures and names #23658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Dec 17, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Fix signatures markup
  • Loading branch information
andresdelfino committed Dec 5, 2020
commit 1eea56789dce017e7a9c625628fc07ab2231d46f
14 changes: 7 additions & 7 deletions Doc/library/asyncio-eventloop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -806,7 +806,7 @@ TLS Upgrade
Watching file descriptors
^^^^^^^^^^^^^^^^^^^^^^^^^

.. method:: loop.add_reader(fd, callback, \*args)
.. method:: loop.add_reader(fd, callback, *args)

Start monitoring the *fd* file descriptor for read availability and
invoke *callback* with the specified arguments once *fd* is available for
Expand All @@ -816,7 +816,7 @@ Watching file descriptors

Stop monitoring the *fd* file descriptor for read availability.

.. method:: loop.add_writer(fd, callback, \*args)
.. method:: loop.add_writer(fd, callback, *args)

Start monitoring the *fd* file descriptor for write availability and
invoke *callback* with the specified arguments once *fd* is available for
Expand Down Expand Up @@ -1029,7 +1029,7 @@ Working with pipes
Unix signals
^^^^^^^^^^^^

.. method:: loop.add_signal_handler(signum, callback, \*args)
.. method:: loop.add_signal_handler(signum, callback, *args)

Set *callback* as the handler for the *signum* signal.

Expand Down Expand Up @@ -1064,7 +1064,7 @@ Unix signals
Executing code in thread or process pools
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. awaitablemethod:: loop.run_in_executor(executor, func, \*args)
.. awaitablemethod:: loop.run_in_executor(executor, func, *args)

Arrange for *func* to be called in the specified executor.

Expand Down Expand Up @@ -1237,9 +1237,9 @@ async/await code consider using the high-level
subprocesses. See :ref:`Subprocess Support on Windows
<asyncio-windows-subprocess>` for details.

.. coroutinemethod:: loop.subprocess_exec(protocol_factory, \*args, \
.. coroutinemethod:: loop.subprocess_exec(protocol_factory, *args, \
stdin=subprocess.PIPE, stdout=subprocess.PIPE, \
stderr=subprocess.PIPE, \*\*kwargs)
stderr=subprocess.PIPE, **kwargs)

Create a subprocess from one or more string arguments specified by
*args*.
Expand Down Expand Up @@ -1321,7 +1321,7 @@ async/await code consider using the high-level

.. coroutinemethod:: loop.subprocess_shell(protocol_factory, cmd, \*, \
stdin=subprocess.PIPE, stdout=subprocess.PIPE, \
stderr=subprocess.PIPE, \*\*kwargs)
stderr=subprocess.PIPE, **kwargs)

Create a subprocess from *cmd*, which can be a :class:`str` or a
:class:`bytes` string encoded to the
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/asyncio-policy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ implementation used by the asyncio event loop:

.. class:: AbstractChildWatcher

.. method:: add_child_handler(pid, callback, \*args)
.. method:: add_child_handler(pid, callback, *args)

Register a new child handler.

Expand Down
6 changes: 3 additions & 3 deletions Doc/library/asyncio-subprocess.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ See also the `Examples`_ subsection.
Creating Subprocesses
=====================

.. coroutinefunction:: create_subprocess_exec(program, \*args, stdin=None, \
stdout=None, stderr=None, limit=None, \*\*kwds)
.. coroutinefunction:: create_subprocess_exec(program, *args, stdin=None, \
stdout=None, stderr=None, limit=None, **kwds)

Create a subprocess.

Expand All @@ -77,7 +77,7 @@ Creating Subprocesses


.. coroutinefunction:: create_subprocess_shell(cmd, stdin=None, \
stdout=None, stderr=None, limit=None, \*\*kwds)
stdout=None, stderr=None, limit=None, **kwds)

Run the *cmd* shell command.

Expand Down
4 changes: 2 additions & 2 deletions Doc/library/asyncio-task.rst
8000
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ Sleeping
Running Tasks Concurrently
==========================

.. awaitablefunction:: gather(\*aws, return_exceptions=False)
.. awaitablefunction:: gather(*aws, return_exceptions=False)

Run :ref:`awaitable objects <asyncio-awaitables>` in the *aws*
sequence *concurrently*.
Expand Down Expand Up @@ -593,7 +593,7 @@ Waiting Primitives
Running in Threads
==================

.. coroutinefunction:: to_thread(func, /, \*args, \*\*kwargs)
.. coroutinefunction:: to_thread(func, /, *args, **kwargs)

Asynchronously run function *func* in a separate thread.

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/contextvars.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Manual Context Management

Context implements the :class:`collections.abc.Mapping` interface.

.. method:: run(callable, \*args, \*\*kwargs)
.. method:: run(callable, *args, **kwargs)

Execute ``callable(*args, **kwargs)`` code in the context object
the *run* method is called on. Return the result of the execution
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/ctypes.rst
A36C
Original file line number Diff line number Diff line change
Expand Up @@ -2508,7 +2508,7 @@ other data types containing pointer type fields.
Arrays and pointers
^^^^^^^^^^^^^^^^^^^

.. class:: Array(\*args)
.. class:: Array(*args)

Abstract base class for arrays.

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/sysconfig.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ can be accessed using :func:`get_config_vars` or :func:`get_config_var`.

Notice that on Windows, it's a much smaller set.

.. function:: get_config_vars(\*args)
.. function:: get_config_vars(*args)

With no arguments, return a dictionary of all configuration variables
relevant for the current platform.
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/tarfile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Some facts and figures:
Added support for :mod:`lzma` compression.


.. function:: open(name=None, mode='r', fileobj=None, bufsize=10240, \*\*kwargs)
.. function:: open(name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)

Return a :class:`TarFile` object for the pathname *name*. For detailed
information on :class:`TarFile` objects and the keyword arguments that are
Expand Down
0