Changes between Version 9 and Version 10 of Contributing/CodingStyle
- Timestamp:
- 02/20/2014 06:05:33 PM (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Contributing/CodingStyle
v9 v10 3 3 == Common == 4 4 * Max line length `119` rather than usual `79`. That said, where possible keep to `79`. 5 6 5 7 6 8 == Python == … … 22 24 * All path separators used within code should be converted to posix format `/`, so should not contain `\` or `\\`. This is to prevent confusion when dealing with cross-platform clients and servers. 23 25 26 === Docstrings === 27 28 You will find a mix of the older [http://docutils.sourceforge.net/docs/user/rst/quickref.html reStructuredText] and [http://sphinxcontrib-napoleon.readthedocs.org/en/latest/ Sphinx Napoleon] format. 29 30 Going forward the Napoleon [http://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_google.html Google Style] will be used for all new doctrings and eventually convert over the rest. 31 32 === Single or Double Quotes === 33 34 The python code base should be `"double quotes"`. 35 24 36 === Python References === 25 37 … … 34 46 * Class names should be in !CamelCase 35 47 * Instances of classes should use camelCase. 48 49 === Single or Double Quotes === 50 51 For the javascript code use `'single quotes'`. 36 52 37 53 == Commit Messages ==