iSharkFly-Open
/
python-peps
mirror of https://github.com/python/peps.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update pep-0008.txt (#433) 

Update pep-0008.txt

Clarified contradictions regarding comment formatting. NB Complete sentences should have a period.
This commit is contained in:
toonarmycaptain 2017-10-25 10:28:55 -05:00 committed by Barry Warsaw
parent 7bd9f7cfb2
commit baef778005
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
pep-0008.txt
View File

@ -690,16 +690,15 @@ Comments that contradict the code are worse than no comments. Always
make a priority of keeping the comments up-to-date when the code make a priority of keeping the comments up-to-date when the code
changes! changes!
Comments should be complete sentences. If a comment is a phrase or Comments should be complete sentences. The first word should be
sentence, its first word should be capitalized, unless it is an capitalized, unless it is an identifier that begins with a lower case
identifier that begins with a lower case letter (never alter the case letter (never alter the case of identifiers!).
of identifiers!).
If a comment is short, the period at the end can be omitted. Block Block comments generally consist of one or more paragraphs built out of
comments generally consist of one or more paragraphs built out of complete sentences, with each sentence ending in a period.
complete sentences, and each sentence should end in a period.
You should use two spaces after a sentence-ending period. You should use two spaces after a sentence-ending period in multi
sentence comments, except after the final sentence.
When writing English, follow Strunk and White. When writing English, follow Strunk and White.