Skip to content

gh-116281: Remove wrong '\' from '\*' in some doc signatures #116282

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.

Sign up for GitHub

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 1 commit into from
Mar 3, 2024
Merged

gh-116281: Remove wrong '\' from '\*' in some doc signatures #116282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion Doc/library/asyncio-stream.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ StreamWriter
be resumed. When there is nothing to wait for, the :meth:`drain`
returns immediately.

.. coroutinemethod:: start_tls(sslcontext, \*, server_hostname=None, \
.. coroutinemethod:: start_tls(sslcontext, *, server_hostname=None, \
ssl_handshake_timeout=None, ssl_shutdown_timeout=None)

Upgrade an existing stream-based connection to TLS.
Expand Down
8 changes: 4 additions & 4 deletions Doc/library/enum.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ Data Types
final *enum*, as well as creating the enum members, properly handling
duplicates, providing iteration over the enum class, etc.

.. method:: EnumType.__call__(cls, value, names=None, \*, module=None, qualname=None, type=None, start=1, boundary=None)
.. method:: EnumType.__call__(cls, value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

This method is called in two different ways:

Expand Down Expand Up @@ -350,7 +350,7 @@ Data Types
>>> PowersOfThree.SECOND.value
9

.. method:: Enum.__init__(self, \*args, \**kwds)
.. method:: Enum.__init__(self, *args, **kwds)

By default, does nothing. If multiple values are given in the member
assignment, those values become separate arguments to ``__init__``; e.g.
Expand All @@ -361,7 +361,7 @@ Data Types

``Weekday.__init__()`` would be called as ``Weekday.__init__(self, 1, 'Mon')``

.. method:: Enum.__init_subclass__(cls, \**kwds)
.. method:: Enum.__init_subclass__(cls, **kwds)

A *classmethod* that is used to further configure subsequent subclasses.
By default, does nothing.
Expand All @@ -388,7 +388,7 @@ Data Types
>>> Build('deBUG')
<Build.DEBUG: 'debug'>

.. method:: Enum.__new__(cls, \*args, \**kwds)
.. method:: Enum.__new__(cls, *args, **kwds)

By default, doesn't exist. If specified, either in the enum class
definition or in a mixin class (such as ``int``), all values given
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/hashlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ More condensed:
Constructors
------------

.. function:: new(name[, data], \*, usedforsecurity=True)
.. function:: new(name[, data], *, usedforsecurity=True)

Is a generic constructor that takes the string *name* of the desired
algorithm as its first parameter. It also exists to allow access to the
Expand Down