summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2024-03-03 19:42:22 (GMT)
committerGitHub <noreply@github.com>2024-03-03 19:42:22 (GMT)
commite95e837541577f03ebaa56de2b1d4b6e399218c2 (patch)
tree0254867ac324dc5b0b6617762416cabf33fa0a8e
parent3f830adf58745723dba5b7fcf7cb39e4c0d0224b (diff)
downloadcpython-e95e837541577f03ebaa56de2b1d4b6e399218c2.zip
cpython-e95e837541577f03ebaa56de2b1d4b6e399218c2.tar.gz
cpython-e95e837541577f03ebaa56de2b1d4b6e399218c2.tar.bz2
[3.12] gh-116281: Remove wrong '\' from '\*' in some doc signatures (GH-116282) (#116285)
gh-116281: Remove wrong '\' from '\*' in some doc signatures (GH-116282) (cherry picked from commit 4859ecb8609b51e2f6b8fb1b295e9ee0f83e1be6) Co-authored-by: HarryLHW <123lhw321@gmail.com>
-rw-r--r--Doc/library/asyncio-stream.rst2
-rw-r--r--Doc/library/enum.rst8
-rw-r--r--Doc/library/hashlib.rst2
3 files changed, 6 insertions, 6 deletions
diff --git a/Doc/library/asyncio-stream.rst b/Doc/library/asyncio-stream.rst
index 3ce6f4f..0b384eb 100644
--- a/Doc/library/asyncio-stream.rst
+++ b/Doc/library/asyncio-stream.rst
@@ -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.
diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst
index a03961b..28dae42 100644
--- a/Doc/library/enum.rst
+++ b/Doc/library/enum.rst
@@ -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:
@@ -340,7 +340,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.
@@ -351,7 +351,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.
@@ -378,7 +378,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
diff --git a/Doc/library/hashlib.rst b/Doc/library/hashlib.rst
index eb650c1..8785bb7 100644
--- a/Doc/library/hashlib.rst
+++ b/Doc/library/hashlib.rst
@@ -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