From baef778005f6883005201e00761c4a611e933aa2 Mon Sep 17 00:00:00 2001 From: toonarmycaptain Date: Wed, 25 Oct 2017 10:28:55 -0500 Subject: [PATCH] Update pep-0008.txt (#433) Update pep-0008.txt Clarified contradictions regarding comment formatting. NB Complete sentences should have a period. --- pep-0008.txt | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/pep-0008.txt b/pep-0008.txt index f7b450133..3e5caaa5c 100644 --- a/pep-0008.txt +++ b/pep-0008.txt @@ -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 changes! -Comments should be complete sentences. If a comment is a phrase or -sentence, its first word should be capitalized, unless it is an -identifier that begins with a lower case letter (never alter the case -of identifiers!). +Comments should be complete sentences. The first word should be +capitalized, unless it is an identifier that begins with a lower case +letter (never alter the case of identifiers!). -If a comment is short, the period at the end can be omitted. Block -comments generally consist of one or more paragraphs built out of -complete sentences, and each sentence should end in a period. +Block comments generally consist of one or more paragraphs built out of +complete sentences, with each sentence ending 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.