Skip to content

Add a page to map things to their PEPs #679

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

Closed
uranusjr opened this issue Nov 29, 2019 · 7 comments
Closed

Add a page to map things to their PEPs #679

uranusjr opened this issue Nov 29, 2019 · 7 comments

Comments

@uranusjr
Copy link
Member

I saw @pfmoore on discuss.python.org and realise I am in the same situation a lot as well. The PEP numbers are difficult to memorise (I can remember 517 and 518 from the top of my head and that’s about it), and I need to constantly search to know what PEP defines (the newset version of) wheel, that defines version specifiers, the core metadata, etc. Would it make sense to add a list so people can easily find the PEPs they are looking for?

@webknjaz
Copy link
Member

It sounds like a good idea but I'm pretty sure I personally would still resort to googling things. And I think that a lot of folks would do the same. So such a page must also be SEO optimized.

@pradyunsg
Copy link
Member

I like this idea too - we should list related PEPs on the page listing the specifications.

@webknjaz
Copy link
Member

Or/and maybe have some sort of a box "related PEPs" on each docs page?

@ncoghlan
Copy link
Member

ncoghlan commented Dec 7, 2019

The entire idea behind https://packaging.python.org/specifications/ is that folks should be relying on those stable URLs, so the PEPs only need to cover the changes between versions.

We unfortunately mishandled PEP 517 in that regard, as it used the PEP itself as the specification, rather than creating a suitable entry on the specifications page (preferably a combined one with PEP 518 that covered pyproject.toml as a whole, rather than piecemeal)

@ncoghlan
Copy link
Member

ncoghlan commented Dec 7, 2019

See https://packaging.python.org/specifications/core-metadata/ for a case that Dustin already fixed - while there's a reference to the most recent PEP, the page itself contains everything you need.

https://packaging.python.org/specifications/platform-compatibility-tags/ is another example where the spec page is properly up to date for the status quo (although it will be updated again as PEP 600 is rolled out with the perennial manylinux tags)

https://packaging.python.org/specifications/distribution-formats/ is the page that needs updating to cover pyproject.toml properly.

@ibraheemybg
Copy link

I think adding a link that maps to their pep is a great idea and it will enhance fastness when using the tool..I could work on this project if given the opportunity

@jeanas
Copy link
Contributor

jeanas commented Jan 16, 2024

I'm going to close this since it's agreed that we should finish importing all specs (#1093) so that consulting PEPs is not necessary at all. (Multiple PRs towards this goal are currently awaiting review.) Also, #1464 added references to the relevant PEPs at the bottom of each spec.

@jeanas jeanas closed this as completed Jan 16, 2024
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

No branches or pull requests

6 participants