Skip to content

base: replace PEP 541 link with user documentation link #17999

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

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

Conversation

woodruffw
Copy link
Member

To keep things balanced between the different columns, I've removed the link to PEP 541 and replaced it with a link to the user docs.

This has the downside of removing a link to the index's name retention polcies. However, I think there are two possible resolutions here:

  1. Add the retention policies within the user docs (i.e. by copying them from the PEP and adding a "living" banner to the PEP, similar to other packaging PEPs)
  2. Add the retention policies to https://policies.python.org (under the PyPI group) instead, since they're conceptually related to the other policies (AUP, T&C).

Curious what others think about either of the above 🙂

Closes #17959.

Signed-off-by: William Woodruff <william@trailofbits.com>
@woodruffw woodruffw requested a review from a team as a code owner April 21, 2025 19:58
@woodruffw woodruffw requested review from di and miketheman April 21, 2025 19:58
@woodruffw woodruffw self-assigned this Apr 21, 2025
@woodruffw woodruffw added the HTML requires change to HTML files label Apr 21, 2025
Copy link
Member

@miketheman miketheman left a comment

Choose a reason for hiding this comment

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

I'm generally in favor of moving away from calling things a "PEP 541 request" and codifying it in a Policy, thus allowing further evolution of the policy and departing from the PEP number.

Not to increase scope too heavily, but that effort should be paired with updates to pypi/support tracker and other places where the policy is mentioned.

@woodruffw
Copy link
Member Author

I'm generally in favor of moving away from calling things a "PEP 541 request" and codifying it in a Policy, thus allowing further evolution of the policy and departing from the PEP number.

Sounds good! In that case what I'll do is copy the policy bits of PEP 541 into a new PR against policies.python.org, which will then be a blocker before landing this 🙂

Not to increase scope too heavily, but that effort should be paired with updates to pypi/support tracker and other places where the policy is mentioned.

I can do a survey of these points.

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

Successfully merging this pull request may close these issues.

Add link to user documentation at https://docs.pypi.org/ in footer or other prominent location
2 participants