Changes between Version 10 and Version 11 of TracDev/CodingStyle

Timestamp:

Sep 9, 2009, 8:18:27 PM (15 years ago)

Author:

Remy Blank

Comment:

Added a note about global declarations.

TracDev/CodingStyle

@@ -19 +19 @@
    No, it's not because we're mainly using VT100 terminals while developing Trac,
    rather because the diffs look nicer on short lines, especially in side-by-side mode.
- * ''never'' use multiple statements on the same line, e.g. `if check: a = 0`. 
+ * ''Never'' use multiple statements on the same line, e.g. `if check: a = 0`. 
  * Prefer list comprehension to the built-in functions `filter()` and `map()` when appropriate.
  * Use `raise TracError("message")` instead of `raise TracError, "message"`
+ * Only use a `global` declaration in a function if that function actually modifies a global variable.
  * A little difference from PEP:0257: we usually don't ''insert a blank line between the last paragraph in a multi-line docstring and its closing quotes''.
  * Also, in docstrings, we make quite a liberal usage of WikiFormatting.