FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Add reference to PEP 610 by sbidoul · Pull Request #690 · pypa/packaging.python.org · GitHub

Add reference to PEP 610 - #690

Merged
ncoghlan merged 2 commits into
pypa:masterfrom
sbidoul:add-pep610-sbi
Jan 3, 2021
Merged

Add reference to PEP 610#690
ncoghlan merged 2 commits into
pypa:masterfrom
sbidoul:add-pep610-sbi

Conversation

sbidoul commented Jan 25, 2020

Copy link
Copy Markdown
Member

ncoghlan left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

The text here should be the specification, rather than just a pointer to the PEP (similar to the way the core metadata is now described).

That way, future PEPs only need to describe what they're changing or adding, without needing to repeat everything that remained the same.

sbidoul commented Jan 26, 2020
edited
Loading

Copy link
Copy Markdown
Member Author

@ncoghlan ah ok, I was not sure since many other entries in the specifications page are merely pointers to the related PEP.

At which point should we copy the spec here? I assume the PEP should move out of Draft state first?

Copy link
Copy Markdown
Member

@sbidoul We used to use the PEPs as the primary reference, so we've just been opportunistically migrating them as they get updated for other reasons (e.g. PEP 566 was really about defining metadata 2.1, but it also migrated to using packaging.python.org as the main reference page for the core metadata spec).

But yeah, for the initial draft, it makes sense to get it to Accepted before duplicating all the details over here. The key thing to add to the PEP is the long term URL you plan to use, and I think your suggestion of https://packaging.python.org/specifications/direct-url is a clear and sensible choice.

sbidoul commented Jan 26, 2020

Copy link
Copy Markdown
Member Author

The key thing to add to the PEP is the long term URL you plan to use, and I think your suggestion of https://packaging.python.org/specifications/direct-url is a clear and sensible choice

@ncoghlan done in python/peps#1283

sbidoul force-pushed the add-pep610-sbi branch 3 times, most recently from 121209f to cb1dc77 Compare January 1, 2021 18:08

sbidoul commented Jan 1, 2021

Copy link
Copy Markdown
Member Author

I updated this PR with the full specification extracted from PEP 610.

cc/ @ncoghlan @pradyunsg

pradyunsg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I've skimmed this to check the major bits, and not gone line by line. OTOH, I'm pretty sure that @sbidoul isn't gonna sneakily change a detail from their own PEP. 🙃

It can be added later when we have implementation experience.

sbidoul commented Jan 2, 2021

Copy link
Copy Markdown
Member Author

@pradyunsg indeed, I only tweaked rst formatting (title underlines and roles), and adjusted the first few lines so it reads better.

This reminds me, though, that I had said that I'd leave out the part about resolved_revision and resolved_revision_type in the spec, because it is currently not implemented anywhere. So I've just added a commit removing that.

ncoghlan merged commit 0575db2 into pypa:master Jan 3, 2021
sbidoul deleted the add-pep610-sbi branch January 3, 2021 15:04
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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.

3 participants


Back | FazBrowse Home | New Git URL