diff --git a/CodingStandards.md b/CodingStandards.md index aee5d73..349aa8f 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, docstrings +### comments, idioms, miscellany, license, imports, docstrings, line widths Here is a useful header for starting new Python files: @@ -35,6 +35,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.) + * 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!) ### truths and falsehoods