From 345d10c382a0611731cb97443765566c30acba24 Mon Sep 17 00:00:00 2001
From: zooko <>
Date: Sun, 14 Aug 2011 02:28:36 +0000
Subject: [PATCH] add formatting convention suggested by David-Sarah on #393

[Imported from Trac: page CodingStandards, version 14]
---
 CodingStandards.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/CodingStandards.md b/CodingStandards.md
index 3234472..1c0d26f 100644
--- a/CodingStandards.md
+++ b/CodingStandards.md
@@ -34,6 +34,7 @@ from allmydata.util.assertutil import _assert, precondition, postcondition
 ```
 
  * Put two blank lines between classes.
+ * Put one blank line before a block comment if the preceding line is code at the same indent level (this makes it harder to mistake the code as part of the comment, and makes the comment easier to read). 
  * 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.)
  * Ignore the part of PEP-8 which specifes 79- or 72- char line widths.  Use whatever line-widths look best to you in your editor on your screen.  Please don't change other people's line-widths unnecessarily, making it look better on your display and worse on theirs.  That's not nice.  (Note: unless you are Brian.  Brian can do anything he wants!)