[Python-Dev] Is there any docstring format used inside CPython core?
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. ___ Python-Dev mailing list Python-Dev@python.org https://mail.python.org/mailman/listinfo/python-dev Unsubscribe: https://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com
Re: [Python-Dev] Is there any docstring format used inside CPython core?
On 13 April 2017 at 13:26, 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@python.org https://mail.python.org/mailman/listinfo/python-dev Unsubscribe: https://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com
Re: [Python-Dev] Is there any docstring format used inside CPython core?
There are extensive docs for CPython's public API at https://docs.python.org/3/c-api/index.html. 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 wrote: > On 13 April 2017 at 13:26, 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@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) ___ Python-Dev mailing list Python-Dev@python.org https://mail.python.org/mailman/listinfo/python-dev Unsubscribe: https://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com
