PEP 362: Fix formatting of colons in field descriptions (#2590)

This commit is contained in:
David Foster 2022-05-08 13:28:39 -06:00 committed by GitHub
parent ba7ec485b8
commit 7557f1959f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions

View File

@ -42,12 +42,12 @@ it stores a `Parameter object`_ in its ``parameters`` collection.
A Signature object has the following public attributes and methods: A Signature object has the following public attributes and methods:
* return_annotation : object * return_annotation \: object
The "return" annotation for the function. If the function The "return" annotation for the function. If the function
has no "return" annotation, this attribute is set to has no "return" annotation, this attribute is set to
``Signature.empty``. ``Signature.empty``.
* parameters : OrderedDict * parameters \: OrderedDict
An ordered mapping of parameters' names to the corresponding An ordered mapping of parameters' names to the corresponding
Parameter objects. Parameter objects.
@ -134,16 +134,16 @@ function parameter.
A Parameter object has the following public attributes and methods: A Parameter object has the following public attributes and methods:
* name : str * name \: str
The name of the parameter as a string. Must be a valid The name of the parameter as a string. Must be a valid
python identifier name (with the exception of ``POSITIONAL_ONLY`` python identifier name (with the exception of ``POSITIONAL_ONLY``
parameters, which can have it set to ``None``.) parameters, which can have it set to ``None``.)
* default : object * default \: object
The default value for the parameter. If the parameter has no The default value for the parameter. If the parameter has no
default value, this attribute is set to ``Parameter.empty``. default value, this attribute is set to ``Parameter.empty``.
* annotation : object * annotation \: object
The annotation for the parameter. If the parameter has no The annotation for the parameter. If the parameter has no
annotation, this attribute is set to ``Parameter.empty``. annotation, this attribute is set to ``Parameter.empty``.
@ -220,14 +220,14 @@ to the function's parameters.
Has the following public attributes: Has the following public attributes:
* arguments : OrderedDict * arguments \: OrderedDict
An ordered, mutable mapping of parameters' names to arguments' values. An ordered, mutable mapping of parameters' names to arguments' values.
Contains only explicitly bound arguments. Arguments for Contains only explicitly bound arguments. Arguments for
which ``bind()`` relied on a default value are skipped. which ``bind()`` relied on a default value are skipped.
* args : tuple * args \: tuple
Tuple of positional arguments values. Dynamically computed from Tuple of positional arguments values. Dynamically computed from
the 'arguments' attribute. the 'arguments' attribute.
* kwargs : dict * kwargs \: dict
Dict of keyword arguments values. Dynamically computed from Dict of keyword arguments values. Dynamically computed from
the 'arguments' attribute. the 'arguments' attribute.