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

Infra: Add directives to show warning banner for deprecated PEPs #3682

Merged
merged 20 commits into from
Apr 14, 2024

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Feb 18, 2024

For #2719.

(Draft to avoid pinging codeowners.)

Add directives for abandoned, rejected, superseded or withdrawn PEPs.

Apply the directive to the first few as a demo.


📚 Documentation preview 📚: https://pep-previews--3682.org.readthedocs.build/#abandoned-withdrawn-and-rejected-peps

@CAM-Gerlach CAM-Gerlach self-requested a review February 26, 2024 04:22
@CAM-Gerlach CAM-Gerlach added enhancement infra Core infrastructure for building and rendering PEPs labels Feb 26, 2024
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

This is a great improvement overall; thanks @hugovk ! I just had a few comments on the implementation and on some of the individual PEP notices. Thanks!

peps/pep-0042.rst Outdated Show resolved Hide resolved
peps/pep-0042.rst Outdated Show resolved Hide resolved
peps/pep-0003.rst Show resolved Hide resolved
pep_sphinx_extensions/__init__.py Outdated Show resolved Hide resolved
peps/pep-0239.rst Outdated Show resolved Hide resolved
peps/pep-0242.rst Outdated Show resolved Hide resolved
peps/pep-0242.rst Outdated Show resolved Hide resolved
peps/pep-0363.rst Show resolved Hide resolved
peps/pep-0426.rst Show resolved Hide resolved
@hugovk
Copy link
Member Author

hugovk commented Feb 26, 2024

Thanks for the review! I'll follow up on the other items tomorrow :)

peps/pep-0215.rst Outdated Show resolved Hide resolved
peps/pep-0241.rst Outdated Show resolved Hide resolved
@hugovk
Copy link
Member Author

hugovk commented Feb 27, 2024

@CAM-Gerlach Review comments addressed, thanks!

@hugovk
Copy link
Member Author

hugovk commented Apr 9, 2024

If there's no further comments let's merge and work on the remainder in batches.

@hugovk hugovk marked this pull request as ready for review April 14, 2024 13:32
@hugovk hugovk merged commit 3e66308 into python:main Apr 14, 2024
23 checks passed
@hugovk hugovk deleted the deprecated-directives branch April 14, 2024 13:35
@malemburg
Copy link
Member

LGTM, but I would have waited more than just 3 minutes for reviews of all the PEP owners 😄

@hugovk
Copy link
Member Author

hugovk commented Apr 14, 2024

Ah sorry, will wait longer for the next batch!

And to further teach me a lesson, I've actually noticed a problem, it's only rendering the "Important" header and not the text saying "This PEP has been withdrawn etc".:

image

https://peps.python.org/pep-0003/

It should be:

image

It was okay originally, and I think I must have checked a cached version after updating the branch from main just before merge. I think what is needed is a newline between the directive and the text, I'll get onto it immediately.

@hugovk
Copy link
Member Author

hugovk commented Apr 14, 2024

Please see PR #3756 as a followup.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement infra Core infrastructure for building and rendering PEPs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants