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

Do not include a per-file copyright header 

[Imported from Trac: page CodingStandards, version 26]
daira 2013-12-19 01:27:59 +00:00
parent efce6a572d
commit a28892385e
1 changed files with 2 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CodingStandards.md

@ -17,11 +17,8 @@ Tahoe requires Python v2.6.6 or greater (although the current code only refuses
Here is a useful header for starting new Python files: Here is a useful header for starting new Python files:
``` ```
# Copyright (c) 2011 The Tahoe-LAFS Software Foundation
# This file is part of Tahoe-LAFS; see doc/about.html for licensing terms.
""" """
doc string describing the module here optional doc string describing the module here
""" """
# import Python Standard Library modules here # import Python Standard Library modules here
@ -33,6 +30,7 @@ from allmydata.util.assertutil import _assert, precondition, postcondition
# your code here # your code here
``` ```
* Do not include a per-file copyright header (they just get out of date and are redundant with source:README.txt).
* Put two blank lines between classes. * 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). * 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. * 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.