From c38782c4bc63985e3feb43cd02a18971da1604ab Mon Sep 17 00:00:00 2001
From: zooko <>
Date: Sat, 21 Nov 2009 04:24:32 +0000
Subject: [PATCH] update about docstring trailing """'s

[Imported from Trac: page CodingStandards, version 9]
---
 CodingStandards.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/CodingStandards.md b/CodingStandards.md
index bc327c9..aee5d73 100644
--- a/CodingStandards.md
+++ b/CodingStandards.md
@@ -12,7 +12,7 @@ Tahoe requires Python v2.4.2 or greater. No effort should be made to offer compa
  * Use `underscore_separated_names` for functions, `CamelCapNames` for classes, `alllowercasenames` for modules, and `ALL_CAPS_NAMES` for constants. Use all lower-case variable names (e.g. `variable_name` or `variablename`). Prepend a leading underscore to private names.
  * Put parenthesis around tuples if it helps make the code more readable, leave them off if not.
 
-### comments, idioms, miscellany, license, imports
+### comments, idioms, miscellany, license, imports, docstrings
 
 Here is a useful header for starting new Python files:
 
@@ -34,6 +34,7 @@ from allmydata.util.assertutil import _assert, precondition, postcondition
 ```
 
  * Feel free to ignore the part of PEP-8 that says to put each module import on a separate line, but don't import modules from multiple separate packages on the same line.
+ * Ignore the part of PEP-257 which says to put the trailing `{"""` of a multi-line docstring on a separate line separated by a blank line.  (That rule appears to have been motivated by a limitation of Emacs which has been fixed.)
 
 ### truths and falsehoods