Changes between Version 9 and Version 10 of Contributing/CodingStyle


Ignore:
Timestamp:
02/20/2014 06:05:33 PM (10 years ago)
Author:
Cas
Comment:

add docstring and quotes

Legend:

Unmodified
Added
Removed
Modified
  • Contributing/CodingStyle

    v9 v10  
    33== Common == 
    44 * Max line length `119` rather than usual `79`. That said, where possible keep to `79`. 
     5 
     6 
    57 
    68== Python == 
     
    2224 * 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. 
    2325 
     26=== Docstrings === 
     27 
     28You 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 
     30Going 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 
     34The python code base should be `"double quotes"`. 
     35 
    2436=== Python References === 
    2537 
     
    3446 * Class names should be in !CamelCase 
    3547 * Instances of classes should use camelCase. 
     48 
     49=== Single or Double Quotes === 
     50 
     51For the javascript code use `'single quotes'`. 
    3652 
    3753== Commit Messages ==