classification
Title: pep-8 requires a few corrections
Type: enhancement Stage: resolved
Components: Documentation Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: barry Nosy List: barry, docs@python, georg.brandl, python-dev, thefourtheye
Priority: normal Keywords: patch

Created on 2016-02-22 13:24 by thefourtheye, last changed 2016-02-22 16:29 by barry. This issue is now closed.

Files
File name Uploaded Description Edit
mywork.patch thefourtheye, 2016-02-22 13:24
Messages (6)
msg260676 - (view) Author: thefourtheye (thefourtheye) * Date: 2016-02-22 13:24
1. It doesn't have the Reference 4 used anywhere in the doc.

2. The `if` condition is not properly ended in the Programming Recommendation section.

3. Apart from that few grammatical changes are necessary I believe.
msg260679 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2016-02-22 13:43
I can't really comment on the grammar changes, but the rest looks good to me.

This is not very smooth, in both versions:

-Consistency within one module or function is most important.
+Consistency within one module or function is the most important thing.
 
-But most importantly: know when to be inconsistent -- sometimes the
-style guide just doesn't apply.  When in doubt, use your best
+But more importantly: know when to be inconsistent -- sometimes the
+style guide just isn't applicable.  When in doubt, use your best

(Consistency is already *most* important, but then comes something *more* important?)
msg260680 - (view) Author: Barry A. Warsaw (barry) * (Python committer) Date: 2016-02-22 14:03
Thanks!  I like some of the changes, and may tweak a few others.  Thanks for the contribution.
msg260682 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2016-02-22 14:05
New changeset 43d612fc6b12 by Barry Warsaw in branch 'default':
Gramatical and other improvements given by thefourtheye.
https://hg.python.org/peps/rev/43d612fc6b12
msg260683 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2016-02-22 14:20
-Consistency within one module or function is most important.
+Consistency within one module or function is the most important.

You left out "thing" from the patch; is that intended?
msg260688 - (view) Author: Barry A. Warsaw (barry) * (Python committer) Date: 2016-02-22 16:29
On Feb 22, 2016, at 02:20 PM, Georg Brandl wrote:

>Georg Brandl added the comment:
>
>-Consistency within one module or function is most important.
>+Consistency within one module or function is the most important.
>
>You left out "thing" from the patch; is that intended?

Yes.
History
Date User Action Args
2016-02-22 16:29:09barrysetmessages: + msg260688
2016-02-22 14:20:48georg.brandlsetmessages: + msg260683
2016-02-22 14:05:52python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg260682

resolution: fixed
stage: resolved
2016-02-22 14:03:04barrysetmessages: + msg260680
2016-02-22 14:02:47barrysetassignee: docs@python -> barry
2016-02-22 13:58:04barrysetnosy: + barry
2016-02-22 13:43:37georg.brandlsetnosy: + georg.brandl
messages: + msg260679
2016-02-22 13:35:56thefourtheyesettitle: pep-8 requires few corrections -> pep-8 requires a few corrections
2016-02-22 13:24:39thefourtheyecreate