Confirmed users
1,927
edits
Auto-tools/Projects/MozBase/WritingDocs: Difference between revisions
Auto-tools/Projects/MozBase/WritingDocs (view source)
Revision as of 22:37, 1 November 2012
, 1 November 2012→Conventions
(Created page with "= Writing docs for Mozbase = == Getting started == * Install sphinx (sudo easy_install sphinx), and read the [http://sphinx.pocoo.org/tutorial.html tutorial] if you aren't fami...") |
|||
| Line 12: | Line 12: | ||
== Conventions == | == Conventions == | ||
* Mozbase is written as "Mozbase" ( | * "Mozbase" is written as "mozbase" normally, as "Mozbase" at the beginning of a sentence, and never as "MozBase" (though there is lingering usage of the latter, particularly in wiki page names). | ||
* Modules (e.g. mozfile) should be written as all lower case | * Modules (e.g. mozfile) should be written as all lower case | ||
* Python conventions for writing docstrings: | * Python conventions for writing docstrings: | ||