Conventions¶
Python¶
documentation with sphinx/restructured text (http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html, http://sphinx-doc.org)
conform to PEP8, PEP257, PEP287
use doctests if useful as documentation
Restructured Text¶
Title characters:
“================”
“—————-”
“~~~~~~~~~~~~~~~~”
“
````````````”“^^^^^^^^^^^^^^^^”
“************”
“++++++++++++++++”
“::::::::::::::::”
Database¶
- capitalization: SOME_KEYWORD, SomeTable, some_table_id, some_column
(compare http://www.vertabelo.com/blog/technical-articles/naming-conventions-in-database-modeling)