Documentación y estilo

A partir de preguntas de varios subi varios links a información adicional acerca de las reglas de estilo para código Python asi como también la documentación.

Brevemente, la sugerencia es atenerse a las reglas de estilo de código Python definidas en el PEP8. Estas reglas defining espacios, capitalización, etc. La única excepción valida es cuando contribuimos a un proyecto que tiene reglas propias (por ejemplo, PyQt sigue las reglas de su proyecto madre que esta en C++: Qt)

Respecto de la documentación, Python tiene strings de documentación dentro del código (llamados docstring). Nuevamente hay varios formatos para esta documentación. Yo sugiero la de NumPy que es sucinta pero completa (aunque algunos de mis proyectos todavía usan reStructuredText de Python)

Finalmente, hay programas que recorren un proyecto o modulo de Python y general una pagina web de documentación. Recomiendo para esto usar sphinx.

Print Friendly, PDF & Email