Rooba
/
attrs
mirror of https://github.com/python-attrs/attrs.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

use fancy :param <type> <name>: syntax in the rest of the attr.ib docstring

This commit is contained in:
Christopher Armstrong 2015-11-18 10:54:05 -06:00 committed by Hynek Schlawack
parent be9a5525bd
commit e99a9d1348
1 changed files with 5 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/attr/_make.py
View File

@ -58,7 +58,7 @@ def attr(default=NOTHING, validator=None,
dicts). dicts).
:type default: Any value. :type default: Any value.
:param validator: :func:`callable` that is called by ``attrs``-generated :param callable validator: :func:`callable` that is called by ``attrs``-generated
``__init__`` methods after the instance has been initialized. They ``__init__`` methods after the instance has been initialized. They
receive the initialized instance, the :class:`Attribute`, and the receive the initialized instance, the :class:`Attribute`, and the
passed value. passed value.
@ -68,20 +68,15 @@ def attr(default=NOTHING, validator=None,
They can be globally disabled and re-enabled using They can be globally disabled and re-enabled using
:func:`get_run_validators`. :func:`get_run_validators`.
:type validator: callable
:param repr: Include this attribute in the generated ``__repr__`` method. :param bool repr: Include this attribute in the generated ``__repr__`` method.
:type repr: bool
:param cmp: Include this attribute in the generated comparison methods :param bool cmp: Include this attribute in the generated comparison methods
(``__eq__`` et al). (``__eq__`` et al).
:type cmp: bool
:param hash: Include this attribute in the generated ``__hash__`` method. :param bool hash: Include this attribute in the generated ``__hash__`` method.
:type hash: bool
:param init: Include this attribute in the generated ``__init__`` method. :param bool init: Include this attribute in the generated ``__init__`` method.
:type init: bool
:param callable convert: :func:`callable` that is called by :param callable convert: :func:`callable` that is called by
``attrs``-generated ``__init__`` methods to convert attribute's value ``attrs``-generated ``__init__`` methods to convert attribute's value