[Python-Dev] "format" builtin function, docstring improvement

Alexander Belopolsky alexander.belopolsky at gmail.com
Thu Feb 9 16:21:43 EST 2017


On Thu, Feb 9, 2017 at 1:18 PM, Hugo PROD HOMME <hugo.prodhomme at gmx.fr>
wrote:
>
> I have made a template of the docstring to begin with, that I send as an
attached file, but I am not familiar with docstring format.

Please open an issue at bugs.python.org.  We did something similar in issue
#9650, [1] so I think this will be well received.  Python docstrings are in
plain text, but you need to consult PEP 436 (The Argument Clinic DSL) [2]
for details. The format() docstring is specified in Python/bltinmodule.c.

[1]: http://bugs.python.org/issue9650
[2]: https://www.python.org/dev/peps/pep-0436/#function-docstring
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-dev/attachments/20170209/37ab9b92/attachment.html>


More information about the Python-Dev mailing list