Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

pep-8 requires a few corrections #70596

Closed
thefourtheye mannequin opened this issue Feb 22, 2016 · 6 comments
Closed

pep-8 requires a few corrections #70596

thefourtheye mannequin opened this issue Feb 22, 2016 · 6 comments
Assignees
@warsaw
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@thefourtheye
Copy link
Mannequin

thefourtheye mannequin commented Feb 22, 2016

BPO 26408
Nosy @warsaw, @birkenfeld
Files
  • mywork.patch
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = 'https://github.com/warsaw'
closed_at = <Date 2016-02-22.14:05:52.817>
created_at = <Date 2016-02-22.13:24:39.365>
labels = ['type-feature', 'docs']
title = 'pep-8 requires a few corrections'
updated_at = <Date 2016-02-22.16:29:09.228>
user = 'https://bugs.python.org/thefourtheye'

    bugs.python.org fields:

    activity = <Date 2016-02-22.16:29:09.228>
actor = 'barry'
assignee = 'barry'
closed = True
closed_date = <Date 2016-02-22.14:05:52.817>
closer = 'python-dev'
components = ['Documentation']
creation = <Date 2016-02-22.13:24:39.365>
creator = 'thefourtheye'
dependencies = []
files = ['42005']
hgrepos = []
issue_num = 26408
keywords = ['patch']
message_count = 6.0
messages = ['260676', '260679', '260680', '260682', '260683', '260688']
nosy_count = 5.0
nosy_names = ['barry', 'georg.brandl', 'docs@python', 'python-dev', 'thefourtheye']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue26408'
versions = []
    @thefourtheye
    Copy link
    Mannequin Author

    thefourtheye mannequin commented Feb 22, 2016

    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.

    @thefourtheye thefourtheye mannequin assigned docspython Feb 22, 2016
    @thefourtheye thefourtheye mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Feb 22, 2016
    @thefourtheye thefourtheye mannequin changed the title pep-8 requires few corrections pep-8 requires a few corrections Feb 22, 2016
    @birkenfeld
    Copy link
    Member

    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?)

    @warsaw warsaw assigned warsaw and unassigned docspython Feb 22, 2016
    @warsaw
    Copy link
    Member

    warsaw commented Feb 22, 2016

    Thanks! I like some of the changes, and may tweak a few others. Thanks for the contribution.

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Feb 22, 2016

    New changeset 43d612fc6b12 by Barry Warsaw in branch 'default':
    Gramatical and other improvements given by thefourtheye.
    https://hg.python.org/peps/rev/43d612fc6b12

    @python-dev python-dev mannequin closed this as completed Feb 22, 2016
    @birkenfeld
    Copy link
    Member

    -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?

    @warsaw
    Copy link
    Member

    warsaw commented Feb 22, 2016

    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.

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees

    @warsaw warsaw

    Labels
    docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @birkenfeld @warsaw