tahoe-lafs/trac-2024-07-25
2
0
Issues 1.1k Wiki Activity

update about docstring trailing """'s 

[Imported from Trac: page CodingStandards, version 9]
zooko 2009-11-21 04:24:32 +00:00
parent a1a026ea4c
commit c38782c4bc
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
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