Fix typos and improve markup in typing.rst.

This commit is contained in:
Berker Peksag 2015-09-10 21:55:50 +03:00
parent 619b283d85
commit 573e2cd383
1 changed files with 18 additions and 19 deletions

View File

@ -60,7 +60,7 @@ Since type information about objects kept in containers cannot be statically
inferred in a generic way, abstract base classes have been extended to support inferred in a generic way, abstract base classes have been extended to support
subscription to denote expected types for container elements. subscription to denote expected types for container elements.
.. code-block:: python ::
from typing import Mapping, Sequence from typing import Mapping, Sequence
@ -70,7 +70,7 @@ subscription to denote expected types for container elements.
Generics can be parametrized by using a new factory available in typing Generics can be parametrized by using a new factory available in typing
called :class:`TypeVar`. called :class:`TypeVar`.
.. code-block:: python ::
from typing import Sequence, TypeVar from typing import Sequence, TypeVar
@ -85,7 +85,7 @@ User-defined generic types
A user-defined class can be defined as a generic class. A user-defined class can be defined as a generic class.
.. code-block:: python ::
from typing import TypeVar, Generic from typing import TypeVar, Generic
from logging import Logger from logging import Logger
@ -220,9 +220,7 @@ The module defines the following classes, functions and decorators:
Type variables exist primarily for the benefit of static type Type variables exist primarily for the benefit of static type
checkers. They serve as the parameters for generic types as well checkers. They serve as the parameters for generic types as well
as for generic function definitions. See class Generic for more as for generic function definitions. See class Generic for more
information on generic types. Generic functions work as follows: information on generic types. Generic functions work as follows::
.. code-block:: python
def repeat(x: T, n: int) -> Sequence[T]: def repeat(x: T, n: int) -> Sequence[T]:
"""Return a list containing n references to x.""" """Return a list containing n references to x."""
@ -238,13 +236,13 @@ The module defines the following classes, functions and decorators:
the return type is still plain :class:`str`. the return type is still plain :class:`str`.
At runtime, ``isinstance(x, T)`` will raise :exc:`TypeError`. In general, At runtime, ``isinstance(x, T)`` will raise :exc:`TypeError`. In general,
:func:`isinstance` and :func:`issublass` should not be used with types. :func:`isinstance` and :func:`issubclass` should not be used with types.
Type variables may be marked covariant or contravariant by passing Type variables may be marked covariant or contravariant by passing
``covariant=True`` or ``contravariant=True``. See :pep:`484` for more ``covariant=True`` or ``contravariant=True``. See :pep:`484` for more
details. By default type variables are invariant. Alternatively, details. By default type variables are invariant. Alternatively,
a type variable may specify an upper bound using ``bound=<type>``. a type variable may specify an upper bound using ``bound=<type>``.
This means that an actual type substituted (explicitly or implictly) This means that an actual type substituted (explicitly or implicitly)
for the type variable must be a subclass of the boundary type, for the type variable must be a subclass of the boundary type,
see :pep:`484`. see :pep:`484`.
@ -278,7 +276,7 @@ The module defines the following classes, functions and decorators:
* You cannot subclass or instantiate a union. * You cannot subclass or instantiate a union.
* You cannot write ``Union[X][Y]`` * You cannot write ``Union[X][Y]``.
* You can use ``Optional[X]`` as a shorthand for ``Union[X, None]``. * You can use ``Optional[X]`` as a shorthand for ``Union[X, None]``.
@ -331,6 +329,7 @@ The module defines the following classes, functions and decorators:
X = TypeVar('X') X = TypeVar('X')
Y = TypeVar('Y') Y = TypeVar('Y')
def lookup_name(mapping: Mapping[X, Y], key: X, default: Y) -> Y: def lookup_name(mapping: Mapping[X, Y], key: X, default: Y) -> Y:
try: try:
return mapping[key] return mapping[key]
@ -347,26 +346,26 @@ The module defines the following classes, functions and decorators:
.. class:: SupportsInt .. class:: SupportsInt
An ABC with one abstract method `__int__`. An ABC with one abstract method ``__int__``.
.. class:: SupportsFloat .. class:: SupportsFloat
An ABC with one abstract method `__float__`. An ABC with one abstract method ``__float__``.
.. class:: SupportsAbs .. class:: SupportsAbs
An ABC with one abstract method `__abs__` that is covariant An ABC with one abstract method ``__abs__`` that is covariant
in its return type. in its return type.
.. class:: SupportsRound .. class:: SupportsRound
An ABC with one abstract method `__round__` An ABC with one abstract method ``__round__``
that is covariant in its return type. that is covariant in its return type.
.. class:: Reversible .. class:: Reversible
An ABC with one abstract method `__reversed__` returning An ABC with one abstract method ``__reversed__`` returning
an `Iterator[T_co]`. an ``Iterator[T_co]``.
.. class:: Container(Generic[T_co]) .. class:: Container(Generic[T_co])
@ -503,9 +502,9 @@ The module defines the following classes, functions and decorators:
Return type hints for a function or method object. Return type hints for a function or method object.
This is often the same as obj.__annotations__, but it handles This is often the same as ``obj.__annotations__``, but it handles
forward references encoded as string literals, and if necessary forward references encoded as string literals, and if necessary
adds Optional[t] if a default value equal to None is set. adds ``Optional[t]`` if a default value equal to None is set.
.. decorator:: no_type_check(arg) .. decorator:: no_type_check(arg)
@ -519,7 +518,7 @@ The module defines the following classes, functions and decorators:
.. decorator:: no_type_check_decorator(decorator) .. decorator:: no_type_check_decorator(decorator)
Decorator to give another decorator the @no_type_check effect. Decorator to give another decorator the :func:`no_type_check` effect.
This wraps the decorator with something that wraps the decorated This wraps the decorator with something that wraps the decorated
function in @no_type_check. function in :func:`no_type_check`.