[Python-ideas] Conventions for Python code documentation (was: PEP 484 (Type Hints) -- first draft round)
graffatcolmingov at gmail.com
Mon Jan 19 20:25:10 CET 2015
There's also PEP 0257 for docstring formatting.
On Mon, Jan 19, 2015 at 12:51 PM, Ben Finney <ben+python at benfinney.id.au> wrote:
> Cem Karan <cfkaran2 at gmail.com> writes:
>> OK, so should there be a convention for writing docstrings?
> The current convention is to use Sphinx to render a reStructuredText
> docstring, and write the API of a class or function with
> reStructuredText field lists.
> Python's own documentation, as well as a large amount of third-party
> packages, are written this way.
> \ “It is seldom that liberty of any kind is lost all at once.” |
> `\ —David Hume |
> _o__) |
> Ben Finney
> Python-ideas mailing list
> Python-ideas at python.org
> Code of Conduct: http://python.org/psf/codeofconduct/
More information about the Python-ideas