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.

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

PEP 685: Conform to PEP 12, address textual errors and improve clarity and phrasing #2396

Merged
merged 3 commits into from
Mar 9, 2022

Conversation

CAM-Gerlach
Copy link
Member

@CAM-Gerlach CAM-Gerlach commented Mar 9, 2022

I corrected a handful of technical, syntax and PEP 12-conformance issues, including with links, mistakenly-retained template text, reST syntax and code block formatting. Furthermore, I proofread for a few apparent typos, spelling mistakes, missing punctuation and grammar errors. Finally, I copyedited it to use clearer phrasing, appropriate diction, avoid distracting repetition, and add a few small clarifications.

Also, should @pfmoore be added as PEP-Delegate, given his standing delegation for packaging metadata and related PEPs?

The use of an underscore/``_`` differs from PEP 503's use of a
hyphen/``-``.
Runs of characters, unlike PEP 503, do **not** get collapsed,
e.g. ``___`` stays the same.

For pip, its
"extra normalisaton behaviour is quite convoluted and eratic",
"extra normalisation behaviour is quite convoluted and erratic",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This appears to be a verbatim quote (given the BrE and multiple typos), so it would be beneficial to link or at least state the source for said quote, to lend it appropriate credibility.

@pfmoore
Copy link
Member

pfmoore commented Mar 9, 2022

should @pfmoore be added as PEP-Delegate

I'm fine with that.

@CAM-Gerlach
Copy link
Member Author

@brettcannon let me know if you'd like me to add that

@brettcannon brettcannon merged commit 49e262f into python:main Mar 9, 2022
@brettcannon
Copy link
Member

should @pfmoore be added as PEP-Delegate, given his standing delegation for packaging metadata and related PEPs?

When I wrote the PEP, Paul had not said he wanted to make a call on it or delegate to someone else, so having it on the first go was a bit premature.

But since Paul has agreed to it, I will add him shortly.

@brettcannon
Copy link
Member

including some consequentially not accurate statements

🤨 That comes off as a bit of a dramatic statement to make for something that's not covered by the PR. Having that sentence here came off to me as, "Brett messed up somewhere, but he won't know how or where until I choose to tell him." I know you didn't mean anything by it, but it is a bit foreboding.

@CAM-Gerlach
Copy link
Member Author

CAM-Gerlach commented Mar 9, 2022

raised_eyebrow That comes off as a bit of a dramatic statement to make for something that's not covered by the PR. Having that sentence here came off to me as, "Brett messed up somewhere, but he won't know how or where until I choose to tell him." I know you didn't mean anything by it, but it is a bit foreboding.

You're 100% right @brettcannon , it was a serious lapse of judgement on my part to include that whole paragraph, and one I should have thought better of as it wasn't relevant to the PR and only adds unnecessary, unhelpful and nonconstructive negativity. I belatedly removed it and sincerely apologize to you for it; I appreciate you giving me the benefit of the doubt, but I couldn't blame you if you didn't reading back now what I wrote. I was tired, hungry and frustrated late last night due to other reasons and should have had the sense to leave it for the morning.

Just for the record, what I was referring to was just some (very understandable) confusion over the exact normalization algorithm and what it does and doesn't do, which I brought up on the thread.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants