Changes between Version 31 and Version 32 of DeveloperGuidelines/CodeConventions

Timestamp:

11/16/13 22:55:41 (11 years ago)

Author:

Dominic König

Comment:

--

DeveloperGuidelines/CodeConventions

@@ -11 +11 @@
 * http://code.google.com/p/soc/wiki/PythonStyleGuide
  * Limit line length to 80 characters
-* Use " " for strings, UNLESS the string contains a ", in which case use '
+* Use " " for strings, UNLESS the string contains a ", in which case use ' (see also [#Quotes Quotes])
 * Global variables should be avoided - use response.s3 to store them.
 
@@ -21 +21 @@
 python static/scripts/tools/pep8.py yourfile.py
 }}}
+
+=== Quotes ===
+
+- for string constants in Python use double quotes " " - UNLESS the string contains "
+- for string constants in JavaScript use single quotes ' ' - UNLESS the string contains a '
+
+- for Inline-JavaScript or JSON inside Python code use ''' '''
+- in all other cases of triple-quoted strings (such as docstrings or Inline-XML) use """ """
+
+- for XML/HTML attributes use double quotes " " (inner quotes must be escaped anyway)
 
 === Naming conventions ===