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

Infra: Add directives to show warning banner for deprecated PEPs by hugovk · Pull Request #3682 · python/peps · GitHub

  1. python
  2. peps

Repository navigation

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

Merged
hugovk merged 20 commits into
python:mainfrom
hugovk:deprecated-directives
Apr 14, 2024
ConversationCommits (20)ChecksFiles changed
Merged

Infra: Add directives to show warning banner for deprecated PEPs#3682
hugovk merged 20 commits into
python:mainfrom
hugovk:deprecated-directives

Conversation

hugovk commented Feb 18, 2024 •
edited
Loading

Copy link
Copy Markdown
Member

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

hugovk mentioned this pull request Feb 18, 2024
Open
CAM-Gerlach self-requested a review February 26, 2024 04:22
CAM-Gerlach added enhancement infra Core infrastructure for building and rendering PEPs labels Feb 26, 2024
CAM-Gerlach reviewed Feb 26, 2024
View reviewed changes

CAM-Gerlach 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

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!

Comment thread peps/pep-0042.rst Outdated
Comment thread peps/pep-0042.rst Outdated
Comment thread peps/pep-0003.rst
Comment thread pep_sphinx_extensions/__init__.py Outdated
Comment thread pep_sphinx_extensions/pep_processor/parsing/pep_banner_directive.py Outdated
Comment thread peps/pep-0239.rst Outdated
Comment thread peps/pep-0242.rst Outdated
Comment thread peps/pep-0242.rst Outdated
Comment thread peps/pep-0363.rst
Comment thread peps/pep-0426.rst

hugovk commented Feb 26, 2024

Copy link
Copy Markdown
Member Author

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

hugovk commented Feb 27, 2024
View reviewed changes
Comment thread peps/pep-0215.rst Outdated
Comment thread peps/pep-0241.rst Outdated
hugovk and others added 14 commits February 27, 2024 15:58
Include "This PEP has been superseded by PEP xxx" in directive template
78b0634 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
PEP 3: Intro section is withdrawal notice
ac2c015 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
PEP 3: ... and de-duplicate
efd0955
PEP 42: update links
48cb093 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
PEP 216: rejection by author is really withdrawal
2e41ad9 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
PEP 216: rejection by author is really withdrawal
c131de6
PEP 224: Add reference to rejection section
08fbdec
PEP 224: Fix reference and link from banner
ccd3192
PEP 239: Fix banner text
ec983b0 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
PEP 242: rejection by author is really withdrawal
5169af7 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
PEP 426: first section is withdrawal notice
aba6113 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
PEP 363: link to rejection discussion from banner
5cb05c2
PEP 426: ... and de-duplicate
6d3e572
Move common directive logic into a subclass
afa418d

hugovk commented Feb 27, 2024

Copy link
Copy Markdown
Member Author

@CAM-Gerlach Review comments addressed, thanks!

hugovk commented Apr 9, 2024

Copy link
Copy Markdown
Member Author

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

hugovk marked this pull request as ready for review April 14, 2024 13:32
hugovk merged commit 3e66308 into python:main Apr 14, 2024
hugovk deleted the deprecated-directives branch April 14, 2024 13:35

malemburg commented Apr 14, 2024

Copy link
Copy Markdown
Member

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

hugovk commented Apr 14, 2024

Copy link
Copy Markdown
Member Author

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".:

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

It should be:

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 mentioned this pull request Apr 14, 2024
Merged

hugovk commented Apr 14, 2024

Copy link
Copy Markdown
Member Author

Please see PR #3756 as a followup.

pradyunsg mentioned this pull request Apr 28, 2024
Draft
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

CAM-Gerlach CAM-Gerlach left review comments
ncoghlan Awaiting requested review from ncoghlan ncoghlan is a code owner
dstufft Awaiting requested review from dstufft dstufft is a code owner
malemburg Awaiting requested review from malemburg malemburg is a code owner
Yhg1s Awaiting requested review from Yhg1s Yhg1s is a code owner
jeremyhylton Awaiting requested review from jeremyhylton jeremyhylton is a code owner
warsaw Awaiting requested review from warsaw warsaw is a code owner
AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

Assignees

No one assigned

Labels

enhancement infra Core infrastructure for building and rendering PEPs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL