Whole-document visible deprecation
Nobody has claimed this yet.
- Dominant language
- reStructuredText
- Stars
- 5k
- Forks
- 1.8k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 25
Description
While discussing the question of updating or superseding/deprecating PEPs, it occurred to me that it would probably be a good idea to display PEPs that aren't active (have been superseded, rejected or otherwise no longer apply) in a way that their status is more apparent than just the one header line at the top, or (like PEP 302) a single note section at the top. If we could have a background text, background colour, floating notice on the side or any kind of visual indication that the text is not authoritative (anymore) even when following a direct link to a section in the PEP, that would be great.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points; start by locating how PEP pages are rendered and how inactive status is represented. Done means inactive PEPs are visibly marked as non-authoritative even when a direct link opens a section.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100