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

Louie Lu me at louie.lu
Thu Apr 13 07:26:55 EDT 2017


Hi everyone,

Is there any docstring format used inside CPython core? e.g. Doxygen.

During the tour to know more about CPython, I found that some part of the
internal function didn't comment that intuitive, for example, `tok_get`
return value, `tok_decimal_tail` description, ...etc.

If there is a exist docstring format or style, I can help to complete it.

If not, is there any plan to introduce the docstring format into the core.
(or maybe some discuss has there before, I can't found inside the
python-dev archive)


Thanks,
Louie.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-dev/attachments/20170413/2de59d00/attachment.html>


More information about the Python-Dev mailing list