Python docstring format?

Sebastian Huber sebastian.huber at embedded-brains.de
Fri Feb 28 09:41:18 UTC 2020


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.

-- 
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.


More information about the devel mailing list