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 440: Make examples clearer #2898

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

konstin
Copy link

@konstin konstin commented Nov 22, 2022

The PEP 440 version matching examples are confusing to read and the 1.1a1 in == 1.1.* is dependent on whether the user requested pre-releases or not, which I've clarified (pypa/packaging#617).


I'm confused because this repository tells me to sign the CLA before I submit a pull request, but the link CLA signing guide then tells me to first open a pull requests and wait for the CLA bot reply

@konstin konstin requested review from ncoghlan and dstufft as code owners Nov 22, 2022
@cpython-cla-bot
Copy link

cpython-cla-bot bot commented Nov 22, 2022

All commit authors signed the Contributor License Agreement.
CLA signed

@konstin
Copy link
Author

konstin commented Nov 22, 2022

When I try to sign the CLA I get an Internal Server Error after signing in with github -.-

@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Nov 23, 2022

I'm not totally sure how the re-ordered text in the comments resolves the confusion mentioned in that thread, but I'll defer that to the appropriate experts and folks you interacted with on the thread, whom I've tagged here.

I'm confused because this repository tells me to sign the CLA before I submit a pull request, but the link CLA signing guide then tells me to first open a pull requests and wait for the CLA bot reply

Sorry, that's out of date—we recently (ish) got a new CLA bot, and there were a couple spots where the text didn't entirely reflect those changes. I've opened #2900 to update those, thanks.

@pfmoore
Copy link
Member

pfmoore commented Nov 23, 2022

The consensus in pypa/packaging#617 seemed to be that the spec should be moved to packaging.python.org, and the updates added there. There's also a similar discussion on Discourse where essentially the same conclusion seemed to have been reached.

I think we need to get consensus on the correct course of action before proceeding here. At the very least, this PR should be mentioned on the Discourse discussion.

@konstin
Copy link
Author

konstin commented Nov 23, 2022

I agree with moving PEP 440 to the specs page to packaging.python.org, but in the meantime, i'd advocate for at least updating the 1.1a1 in == 1.1.* example because otherwise this PEP reads rather contradictory (says it matches there, says only matches under special circumstances in the section about prereleases)

@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Nov 23, 2022

The part I still don't really follow, and one of the reasons why folks might be hesitant to accept this, is why it is necessary to change dozens of comments when it is (unless I misunderstand, which I might) only a ≈couple that are actually causing the confusion here. Even this being a packaging standard aside, the less minimal the change the harder sell it is to accept it, and its certainly a lot more difficult to justify rewriting dozens of comments vs. adding/changing a few words in a couple of them to clarify one very specific point.

@konstin konstin force-pushed the pep440-version-matching-examples branch from fc93e7c to 7d4ef9d Compare Nov 23, 2022
The PEP 440 version matching examples are confusing to read and the `1.1a1` in `== 1.1.*` is dependent on whether the user requested pre-releases or not, which I've clarified (pypa/packaging#617)
@konstin konstin force-pushed the pep440-version-matching-examples branch from 7d4ef9d to 691c38d Compare Nov 23, 2022
@konstin
Copy link
Author

konstin commented Nov 23, 2022

I found the phrasing very confusing when trying to figure out the examples; I've now cut it down to just one line change

@pradyunsg
Copy link
Member

pradyunsg commented Nov 23, 2022

My 2 cents: Let's land this -- it's a small-enough change now and we can come around to moving PEP 440 over to https://packaging.python.org/en/latest/specifications/version-specifiers/ when someone finds the bandwidth to do so.

@brettcannon
Copy link
Member

brettcannon commented Nov 25, 2022

I'm confused because this repository tells me to sign the CLA before I submit a pull request

Where does it say that (so we can look at updating it)?

@brettcannon brettcannon removed their request for review Nov 25, 2022
@JelleZijlstra
Copy link
Member

JelleZijlstra commented Nov 25, 2022

@brettcannon it's being fixed in #2900

@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Nov 26, 2022

(And now merged)

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

Successfully merging this pull request may close these issues.

None yet

6 participants