Python docstring format?

Gedare Bloom gedare at rtems.org
Fri Feb 28 16:36:41 UTC 2020


On Fri, Feb 28, 2020 at 2:41 AM Sebastian Huber
<sebastian.huber at embedded-brains.de> wrote:
>
> Hello,
>
> there are several Python docstring formats available:
>
> https://stackoverflow.com/questions/3898572/what-is-the-standard-python-docstring-format
>
> The reStructuredText Docstring Format (Sphinx) is recommended by PEP 287:
>
> https://www.python.org/dev/peps/pep-0287/
>
> I suggest to use this one for RTEMS as well.
>
That makes sense to me based on our other use of Sphinx.
> --
> Sebastian Huber, embedded brains GmbH
>
> Address : Dornierstr. 4, D-82178 Puchheim, Germany
> Phone   : +49 89 189 47 41-16
> Fax     : +49 89 189 47 41-09
> E-Mail  : sebastian.huber at embedded-brains.de
> PGP     : Public key available on request.
>
> Diese Nachricht ist keine geschäftliche Mitteilung im Sinne des EHUG.
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel


More information about the devel mailing list