[Python-Dev] Is there any docstring format used inside CPython core?

Guido van Rossum guido at python.org
Thu Apr 13 12:39:46 EDT 2017

There are extensive docs for CPython's public API at

For functions that are exposed to Python via an extension module there's
the Argument Clinic, incompletely implemented, see PEP 436 (accepted).

For functions that are neither (like the ones you mention) we use good old
C comments, and if you want to add more of those, please do and submit a PR!

On Thu, Apr 13, 2017 at 9:24 AM, Ivan Levkivskyi <levkivskyi at gmail.com>

> On 13 April 2017 at 13:26, Louie Lu <me at louie.lu> wrote:
>> Hi everyone,
>> Is there any docstring format used inside CPython core? e.g. Doxygen.
> I don't think there is anything beyond https://www.python.org/dev/
> peps/pep-0257/
> --
> Ivan
> _______________________________________________
> Python-Dev mailing list
> Python-Dev at python.org
> https://mail.python.org/mailman/listinfo/python-dev
> Unsubscribe: https://mail.python.org/mailman/options/python-dev/
> guido%40python.org

--Guido van Rossum (python.org/~guido)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-dev/attachments/20170413/b6507dcb/attachment.html>

More information about the Python-Dev mailing list