Doc fixes

Co-authored-by: Alex Waygood <[email protected]>

Author: srittau

Doc/library/io.rst

@@ -1165,8 +1165,9 @@ with :deco:`typing.runtime_checkable`.
    .. method:: read()
                read(size, /)
 
-      Read data from the input stream and return it. If ``size`` is
-      specified, at most ``size`` items (bytes/characters) will be read.
+      Read data from the input stream and return it. If *size* is
+      specified, it should be an integer, and at most *size* items
+      (bytes/characters) will be read.
 
    For example::
 
@@ -1184,16 +1185,16 @@ with :deco:`typing.runtime_checkable`.
 
    .. method:: write(data, /)
 
-      Write data to the output stream and return number of items
+      Write *data* to the output stream and return the number of items
       (bytes/characters) written.
 
    For example::
 
      def write_binary(writer: Writer[bytes]):
          writer.write(b"Hello world!\n")
 
-See :ref:`typing-io` for other I/O related protocols and classes used for
-static type checking.
+See :ref:`typing-io` for other I/O related protocols and classes that can be
+used for static type checking.
 
 Performance
 -----------

Doc/library/typing.rst

@@ -2822,16 +2822,16 @@ The protocols :class:`io.Reader` and :class:`io.Writer` offer a simpler
 alternative for argument types, when only the ``read()`` or ``write()``
 methods are accessed, respectively::
 
-  def read_and_write(reader: Reader[str], writer: Writer[bytes]):
-      data = reader.read()
-      writer.write(data.encode())
+   def read_and_write(reader: Reader[str], writer: Writer[bytes]):
+       data = reader.read()
+       writer.write(data.encode())
 
 Also consider using :class:`collections.abc.Iterable` for iterating over
 the lines of an input stream::
 
-  def read_config(stream: Iterable[str]):
-      for line in stream:
-          ...
+   def read_config(stream: Iterable[str]):
+       for line in stream:
+           ...
 
 Functions and decorators
 ------------------------

Lib/io.py

@@ -119,7 +119,7 @@ class Reader(metaclass=abc.ABCMeta):
     def read(self, size=..., /):
         """Read data from the input stream and return it.
 
-        If "size" is specified, at most "size" items (bytes/characters) will be
+        If *size* is specified, at most *size* items (bytes/characters) will be
         read.
         """
 
@@ -142,7 +142,7 @@ class Writer(metaclass=abc.ABCMeta):
 
     @abc.abstractmethod
     def write(self, data, /):
-        """Write data to the output stream and return number of items written."""
+        """Write *data* to the output stream and return the number of items written."""
 
     @classmethod
     def __subclasshook__(cls, C):