Skip to content

Commit a3f2cf3

Browse files
authored
pythongh-85864: Mark positional-only args in io docs (python#91683)
1 parent 254aaa7 commit a3f2cf3

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

Doc/library/io.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ High-level Module Interface
193193
.. versionadded:: 3.8
194194

195195

196-
.. function:: text_encoding(encoding, stacklevel=2)
196+
.. function:: text_encoding(encoding, stacklevel=2, /)
197197

198198
This is a helper function for callables that use :func:`open` or
199199
:class:`TextIOWrapper` and have an ``encoding=None`` parameter.
@@ -380,7 +380,7 @@ I/O Base Classes
380380
Return ``True`` if the stream can be read from. If ``False``, :meth:`read`
381381
will raise :exc:`OSError`.
382382

383-
.. method:: readline(size=-1)
383+
.. method:: readline(size=-1, /)
384384

385385
Read and return one line from the stream. If *size* is specified, at
386386
most *size* bytes will be read.
@@ -389,7 +389,7 @@ I/O Base Classes
389389
the *newline* argument to :func:`open` can be used to select the line
390390
terminator(s) recognized.
391391

392-
.. method:: readlines(hint=-1)
392+
.. method:: readlines(hint=-1, /)
393393

394394
Read and return a list of lines from the stream. *hint* can be specified
395395
to control the number of lines read: no more lines will be read if the
@@ -475,7 +475,7 @@ I/O Base Classes
475475
:class:`RawIOBase` provides these methods in addition to those from
476476
:class:`IOBase`:
477477

478-
.. method:: read(size=-1)
478+
.. method:: read(size=-1, /)
479479

480480
Read up to *size* bytes from the object and return them. As a convenience,
481481
if *size* is unspecified or -1, all bytes until EOF are returned.
@@ -585,7 +585,7 @@ I/O Base Classes
585585
If *size* is ``-1`` (the default), an arbitrary number of bytes are
586586
returned (more than zero unless EOF is reached).
587587

588-
.. method:: readinto(b)
588+
.. method:: readinto(b, /)
589589

590590
Read bytes into a pre-allocated, writable
591591
:term:`bytes-like object` *b* and return the number of bytes read.
@@ -597,7 +597,7 @@ I/O Base Classes
597597
A :exc:`BlockingIOError` is raised if the underlying raw stream is in non
598598
blocking-mode, and has no data available at the moment.
599599

600-
.. method:: readinto1(b)
600+
.. method:: readinto1(b, /)
601601

602602
Read bytes into a pre-allocated, writable
603603
:term:`bytes-like object` *b*, using at most one call to
@@ -727,7 +727,7 @@ than raw I/O does.
727727
Return :class:`bytes` containing the entire contents of the buffer.
728728

729729

730-
.. method:: read1([size])
730+
.. method:: read1([size], /)
731731

732732
In :class:`BytesIO`, this is the same as :meth:`~BufferedIOBase.read`.
733733

@@ -805,7 +805,7 @@ than raw I/O does.
805805
Force bytes held in the buffer into the raw stream. A
806806
:exc:`BlockingIOError` should be raised if the raw stream blocks.
807807

808-
.. method:: write(b)
808+
.. method:: write(b, /)
809809

810810
Write the :term:`bytes-like object`, *b*, and return the
811811
number of bytes written. When in non-blocking mode, a
@@ -828,7 +828,7 @@ than raw I/O does.
828828
are guaranteed to be implemented.
829829

830830

831-
.. class:: BufferedRWPair(reader, writer, buffer_size=DEFAULT_BUFFER_SIZE)
831+
.. class:: BufferedRWPair(reader, writer, buffer_size=DEFAULT_BUFFER_SIZE, /)
832832

833833
A buffered binary stream providing higher-level access to two non seekable
834834
:class:`RawIOBase` raw binary streams---one readable, the other writeable.
@@ -895,7 +895,7 @@ Text I/O
895895

896896
.. versionadded:: 3.1
897897

898-
.. method:: read(size=-1)
898+
.. method:: read(size=-1, /)
899899

900900
Read and return at most *size* characters from the stream as a single
901901
:class:`str`. If *size* is negative or ``None``, reads until EOF.

0 commit comments

Comments
 (0)