Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitdcc997c

Browse files
[doc] Fix erroneous backslashes in signatures and names (GH-23658)
The issue being resolved is shown in the 3.10 docs (if you select docs for older versions you won't see a visual glitch).The newer sphinx version that produces the 3.10 docs doesn't treat the backslash to escape things in some situations it previously did.
1 parentc143cc3 commitdcc997c

32 files changed

+88
-88
lines changed

‎Doc/library/asyncio-eventloop.rst‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ Creating Futures and Tasks
321321

322322
..versionadded::3.5.2
323323

324-
..method::loop.create_task(coro,\*, name=None)
324+
..method::loop.create_task(coro, *, name=None)
325325

326326
Schedule the execution of a:ref:`coroutine`.
327327
Return a:class:`Task` object.
@@ -356,7 +356,7 @@ Opening network connections
356356
^^^^^^^^^^^^^^^^^^^^^^^^^^^
357357

358358
..coroutinemethod::loop.create_connection(protocol_factory, \
359-
host=None, port=None,\*, ssl=None, \
359+
host=None, port=None, *, ssl=None, \
360360
family=0, proto=0, flags=0, sock=None, \
361361
local_addr=None, server_hostname=None, \
362362
ssl_handshake_timeout=None, \
@@ -482,7 +482,7 @@ Opening network connections
482482
that can be used directly in async/await code.
483483

484484
..coroutinemethod::loop.create_datagram_endpoint(protocol_factory, \
485-
local_addr=None, remote_addr=None,\*, \
485+
local_addr=None, remote_addr=None, *, \
486486
family=0, proto=0, flags=0, \
487487
reuse_address=None, reuse_port=None, \
488488
allow_broadcast=None, sock=None)
@@ -559,7 +559,7 @@ Opening network connections
559559
Added support for Windows.
560560

561561
..coroutinemethod::loop.create_unix_connection(protocol_factory, \
562-
path=None,\*, ssl=None, sock=None, \
562+
path=None, *, ssl=None, sock=None, \
563563
server_hostname=None, ssl_handshake_timeout=None)
564564
565565
Create a Unix connection.
@@ -592,7 +592,7 @@ Creating network servers
592592
^^^^^^^^^^^^^^^^^^^^^^^^
593593

594594
..coroutinemethod::loop.create_server(protocol_factory, \
595-
host=None, port=None,\*, \
595+
host=None, port=None, *, \
596596
family=socket.AF_UNSPEC, \
597597
flags=socket.AI_PASSIVE, \
598598
sock=None, backlog=100, ssl=None, \
@@ -683,7 +683,7 @@ Creating network servers
683683

684684

685685
..coroutinemethod::loop.create_unix_server(protocol_factory, path=None, \
686-
\*, sock=None, backlog=100, ssl=None, \
686+
*, sock=None, backlog=100, ssl=None, \
687687
ssl_handshake_timeout=None, start_serving=True)
688688
689689
Similar to:meth:`loop.create_server` but works with the
@@ -708,7 +708,7 @@ Creating network servers
708708
The *path* parameter can now be a:class:`~pathlib.Path` object.
709709

710710
..coroutinemethod::loop.connect_accepted_socket(protocol_factory, \
711-
sock,\*, ssl=None, ssl_handshake_timeout=None)
711+
sock, *, ssl=None, ssl_handshake_timeout=None)
712712
713713
Wrap an already accepted connection into a transport/protocol pair.
714714

@@ -773,7 +773,7 @@ TLS Upgrade
773773
^^^^^^^^^^^
774774

775775
..coroutinemethod::loop.start_tls(transport, protocol, \
776-
sslcontext,\*, server_side=False, \
776+
sslcontext, *, server_side=False, \
777777
server_hostname=None, ssl_handshake_timeout=None)
778778
779779
Upgrade an existing transport-based connection to TLS.
@@ -806,7 +806,7 @@ TLS Upgrade
806806
Watching file descriptors
807807
^^^^^^^^^^^^^^^^^^^^^^^^^
808808

809-
..method::loop.add_reader(fd, callback,\*args)
809+
..method::loop.add_reader(fd, callback, *args)
810810

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

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

819-
..method::loop.add_writer(fd, callback,\*args)
819+
..method::loop.add_writer(fd, callback, *args)
820820

821821
Start monitoring the *fd* file descriptor for write availability and
822822
invoke *callback* with the specified arguments once *fd* is available for
@@ -930,7 +930,7 @@ convenient.
930930
:meth:`loop.create_server` and:func:`start_server`.
931931

932932
..coroutinemethod::loop.sock_sendfile(sock, file, offset=0, count=None, \
933-
\*, fallback=True)
933+
*, fallback=True)
934934
935935
Send a file using high-performance:mod:`os.sendfile` if possible.
936936
Return the total number of bytes sent.
@@ -964,7 +964,7 @@ convenient.
964964
DNS
965965
^^^
966966

967-
..coroutinemethod::loop.getaddrinfo(host, port,\*, family=0, \
967+
..coroutinemethod::loop.getaddrinfo(host, port, *, family=0, \
968968
type=0, proto=0, flags=0)
969969

970970
Asynchronous version of:meth:`socket.getaddrinfo`.
@@ -1029,7 +1029,7 @@ Working with pipes
10291029
Unix signals
10301030
^^^^^^^^^^^^
10311031

1032-
..method::loop.add_signal_handler(signum, callback,\*args)
1032+
..method::loop.add_signal_handler(signum, callback, *args)
10331033

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

@@ -1064,7 +1064,7 @@ Unix signals
10641064
Executing code in thread or process pools
10651065
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
10661066

1067-
..awaitablemethod::loop.run_in_executor(executor, func,\*args)
1067+
..awaitablemethod::loop.run_in_executor(executor, func, *args)
10681068

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

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

1240-
..coroutinemethod::loop.subprocess_exec(protocol_factory,\*args, \
1240+
..coroutinemethod::loop.subprocess_exec(protocol_factory, *args, \
12411241
stdin=subprocess.PIPE, stdout=subprocess.PIPE, \
1242-
stderr=subprocess.PIPE,\*\*kwargs)
1242+
stderr=subprocess.PIPE,**kwargs)
12431243
12441244
Create a subprocess from one or more string arguments specified by
12451245
*args*.
@@ -1319,9 +1319,9 @@ async/await code consider using the high-level
13191319
conforms to the:class:`asyncio.SubprocessTransport` base class and
13201320
*protocol* is an object instantiated by the *protocol_factory*.
13211321

1322-
..coroutinemethod::loop.subprocess_shell(protocol_factory, cmd,\*, \
1322+
..coroutinemethod::loop.subprocess_shell(protocol_factory, cmd, *, \
13231323
stdin=subprocess.PIPE, stdout=subprocess.PIPE, \
1324-
stderr=subprocess.PIPE,\*\*kwargs)
1324+
stderr=subprocess.PIPE,**kwargs)
13251325
13261326
Create a subprocess from *cmd*, which can be a:class:`str` or a
13271327
:class:`bytes` string encoded to the

‎Doc/library/asyncio-future.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Future Functions
3131
..versionadded::3.5
3232

3333

34-
..function::ensure_future(obj,\*, loop=None)
34+
..function::ensure_future(obj, *, loop=None)
3535

3636
Return:
3737

@@ -58,7 +58,7 @@ Future Functions
5858
The function accepts any:term:`awaitable` object.
5959

6060

61-
..function::wrap_future(future,\*, loop=None)
61+
..function::wrap_future(future, *, loop=None)
6262

6363
Wrap a:class:`concurrent.futures.Future` object in a
6464
:class:`asyncio.Future` object.
@@ -67,7 +67,7 @@ Future Functions
6767
Future Object
6868
=============
6969

70-
..class::Future(\*, loop=None)
70+
..class::Future(*, loop=None)
7171

7272
A Future represents an eventual result of an asynchronous
7373
operation. Not thread-safe.

‎Doc/library/asyncio-policy.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ implementation used by the asyncio event loop:
159159

160160
..class::AbstractChildWatcher
161161

162-
..method::add_child_handler(pid, callback,\*args)
162+
..method::add_child_handler(pid, callback, *args)
163163

164164
Register a new child handler.
165165

‎Doc/library/asyncio-stream.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The following top-level asyncio functions can be used to create
4848
and work with streams:
4949

5050

51-
..coroutinefunction::open_connection(host=None, port=None,\*, \
51+
..coroutinefunction::open_connection(host=None, port=None, *, \
5252
limit=None, ssl=None, family=0, proto=0, \
5353
flags=0, sock=None, local_addr=None, \
5454
server_hostname=None, ssl_handshake_timeout=None)
@@ -71,7 +71,7 @@ and work with streams:
7171
The *ssl_handshake_timeout* parameter.
7272

7373
..coroutinefunction::start_server(client_connected_cb, host=None, \
74-
port=None,\*, limit=None, \
74+
port=None, *, limit=None, \
7575
family=socket.AF_UNSPEC, \
7676
flags=socket.AI_PASSIVE, sock=None, \
7777
backlog=100, ssl=None, reuse_address=None, \
@@ -103,7 +103,7 @@ and work with streams:
103103

104104
..rubric::Unix Sockets
105105

106-
..coroutinefunction::open_unix_connection(path=None,\*, limit=None, \
106+
..coroutinefunction::open_unix_connection(path=None, *, limit=None, \
107107
ssl=None, sock=None, server_hostname=None, \
108108
ssl_handshake_timeout=None)
109109

@@ -126,7 +126,7 @@ and work with streams:
126126

127127

128128
..coroutinefunction::start_unix_server(client_connected_cb, path=None, \
129-
\*, limit=None, sock=None, backlog=100, ssl=None, \
129+
*, limit=None, sock=None, backlog=100, ssl=None, \
130130
ssl_handshake_timeout=None, start_serving=True)
131131
132132
Start a Unix socket server.
@@ -185,7 +185,7 @@ StreamReader
185185
can be read. Use the:attr:`IncompleteReadError.partial`
186186
attribute to get the partially read data.
187187

188-
..coroutinemethod::readuntil(separator=b'\\n')
188+
..coroutinemethod::readuntil(separator=b'\n')
189189

190190
Read data from the stream until *separator* is found.
191191

‎Doc/library/asyncio-subprocess.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ See also the `Examples`_ subsection.
6161
Creating Subprocesses
6262
=====================
6363

64-
..coroutinefunction::create_subprocess_exec(program,\*args, stdin=None, \
65-
stdout=None, stderr=None, limit=None,\*\*kwds)
64+
..coroutinefunction::create_subprocess_exec(program, *args, stdin=None, \
65+
stdout=None, stderr=None, limit=None,**kwds)
6666
6767
Create a subprocess.
6868

@@ -77,7 +77,7 @@ Creating Subprocesses
7777

7878

7979
..coroutinefunction::create_subprocess_shell(cmd, stdin=None, \
80-
stdout=None, stderr=None, limit=None,\*\*kwds)
80+
stdout=None, stderr=None, limit=None,**kwds)
8181
8282
Run the *cmd* shell command.
8383

‎Doc/library/asyncio-task.rst‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ is :meth:`loop.run_in_executor`.
210210
Running an asyncio Program
211211
==========================
212212

213-
..function::run(coro,\*, debug=False)
213+
..function::run(coro, *, debug=False)
214214

215215
Execute the:term:`coroutine` *coro* and return the result.
216216

@@ -247,7 +247,7 @@ Running an asyncio Program
247247
Creating Tasks
248248
==============
249249

250-
..function::create_task(coro,\*, name=None)
250+
..function::create_task(coro, *, name=None)
251251

252252
Wrap the *coro*:ref:`coroutine<coroutine>` into a:class:`Task`
253253
and schedule its execution. Return the Task object.
@@ -316,7 +316,7 @@ Sleeping
316316
Running Tasks Concurrently
317317
==========================
318318

319-
..awaitablefunction::gather(\*aws, return_exceptions=False)
319+
..awaitablefunction::gather(*aws, return_exceptions=False)
320320

321321
Run:ref:`awaitable objects<asyncio-awaitables>` in the *aws*
322322
sequence *concurrently*.
@@ -488,7 +488,7 @@ Timeouts
488488
Waiting Primitives
489489
==================
490490

491-
..coroutinefunction::wait(aws,\*, timeout=None, return_when=ALL_COMPLETED)
491+
..coroutinefunction::wait(aws, *, timeout=None, return_when=ALL_COMPLETED)
492492

493493
Run:ref:`awaitable objects<asyncio-awaitables>` in the *aws*
494494
iterable concurrently and block until the condition specified
@@ -573,7 +573,7 @@ Waiting Primitives
573573
deprecated.
574574

575575

576-
..function::as_completed(aws,\*, timeout=None)
576+
..function::as_completed(aws, *, timeout=None)
577577

578578
Run:ref:`awaitable objects<asyncio-awaitables>` in the *aws*
579579
iterable concurrently. Return an iterator of coroutines.
@@ -593,7 +593,7 @@ Waiting Primitives
593593
Running in Threads
594594
==================
595595

596-
..coroutinefunction::to_thread(func, /,\*args,\*\*kwargs)
596+
..coroutinefunction::to_thread(func, /, *args,**kwargs)
597597

598598
Asynchronously run function *func* in a separate thread.
599599

@@ -723,7 +723,7 @@ Introspection
723723
Task Object
724724
===========
725725

726-
..class::Task(coro,\*, loop=None, name=None)
726+
..class::Task(coro, *, loop=None, name=None)
727727

728728
A:class:`Future-like <Future>` object that runs a Python
729729
:ref:`coroutine<coroutine>`. Not thread-safe.
@@ -889,7 +889,7 @@ Task Object
889889
See the documentation of:meth:`Future.remove_done_callback`
890890
for more details.
891891

892-
..method::get_stack(\*, limit=None)
892+
..method::get_stack(*, limit=None)
893893

894894
Return the list of stack frames for this Task.
895895

@@ -910,7 +910,7 @@ Task Object
910910
stack are returned, but the oldest frames of a traceback are
911911
returned. (This matches the behavior of the traceback module.)
912912

913-
..method::print_stack(\*, limit=None, file=None)
913+
..method::print_stack(*, limit=None, file=None)
914914

915915
Print the stack or traceback for this Task.
916916

‎Doc/library/base64.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ The modern interface provides:
199199
..versionadded::3.4
200200

201201

202-
..function::a85decode(b, *, foldspaces=False, adobe=False, ignorechars=b' \\t\\n\\r\\v')
202+
..function::a85decode(b, *, foldspaces=False, adobe=False, ignorechars=b' \t\n\r\v')
203203

204204
Decode the Ascii85 encoded:term:`bytes-like object` or ASCII string *b* and
205205
return the decoded:class:`bytes`.

‎Doc/library/compileall.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ runtime.
148148
Public functions
149149
----------------
150150

151-
..function::compile_dir(dir, maxlevels=sys.getrecursionlimit(), ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, workers=1, invalidation_mode=None,\*, stripdir=None, prependdir=None, limit_sl_dest=None, hardlink_dupes=False)
151+
..function::compile_dir(dir, maxlevels=sys.getrecursionlimit(), ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, workers=1, invalidation_mode=None, *, stripdir=None, prependdir=None, limit_sl_dest=None, hardlink_dupes=False)
152152

153153
Recursively descend the directory tree named by *dir*, compiling all:file:`.py`
154154
files along the way. Return a true value if all the files compiled successfully,
@@ -231,7 +231,7 @@ Public functions
231231
Added *stripdir*, *prependdir*, *limit_sl_dest* and *hardlink_dupes* arguments.
232232
Default value of *maxlevels* was changed from ``10`` to ``sys.getrecursionlimit()``
233233

234-
..function::compile_file(fullname, ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, invalidation_mode=None,\*, stripdir=None, prependdir=None, limit_sl_dest=None, hardlink_dupes=False)
234+
..function::compile_file(fullname, ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, invalidation_mode=None, *, stripdir=None, prependdir=None, limit_sl_dest=None, hardlink_dupes=False)
235235

236236
Compile the file with path *fullname*. Return a true value if the file
237237
compiled successfully, and a false value otherwise.

‎Doc/library/concurrent.futures.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Executor Objects
6767
..versionchanged::3.5
6868
Added the *chunksize* argument.
6969

70-
..method::shutdown(wait=True,\*, cancel_futures=False)
70+
..method::shutdown(wait=True, *, cancel_futures=False)
7171

7272
Signal the executor that it should free any resources that it is using
7373
when the currently pending futures are done executing. Calls to

‎Doc/library/contextvars.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ See also :pep:`567` for additional details.
2626
Context Variables
2727
-----------------
2828

29-
..class::ContextVar(name, [\*, default])
29+
..class::ContextVar(name, [*, default])
3030

3131
This class is used to declare a new Context Variable, e.g.::
3232

@@ -146,7 +146,7 @@ Manual Context Management
146146

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

149-
..method::run(callable,\*args,\*\*kwargs)
149+
..method::run(callable, *args,**kwargs)
150150

151151
Execute ``callable(*args, **kwargs)`` code in the context object
152152
the *run* method is called on. Return the result of the execution

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp