Enforce the use of `deprecated-removed` in docs

Offen

#92,564 erstellt am 09.5.2022 12 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 5/5
Geschätzter Aufwand: Über eine Woche
Anfängerfreundlichkeit: 25/100

Issue-Typ: Dokumentation
Klarheit: Muss geklärt werden
Aktivitätsstatus: Veraltet
Bereich: documentation

Rechercherichtung

Beginne damit, die dokumentierten grep-Zählungen für deprecated:: und deprecated-removed:: in den .rst-Dateien erneut auszuführen, und prüfe anschließend die zugehörigen Arbeiten in #92308. Die Checkliste des Issues weist darauf hin, dass für den Abschluss Entfernungsversionen festgelegt, eine Automatisierung in Betracht gezogen und entschieden werden müsste, ob die ältere Direktive als veraltet markiert werden soll.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

3.10 3.11 3.12 3.9 (EOL) docs type-feature

In the docs we have two directives that can be used to document deprecations: deprecated and deprecated-removed.

I think we should always prefer the latter:

it will make it easier to track and document removals
it will give people a target, so they can plan around it

Even if the removal version gets postponed, it's better to postpone than to say that something is deprecated and then just remove it at an unspecified time in the future.

Currently deprecated is more commonly used:

$ grep -r 'deprecated::' --include=*.rst | wc -l
226
$ grep -r 'deprecated-removed::' --include=*.rst | wc -l
30

set removal version for deprecated features using deprecated-removed
automate the documentation of deprecations (see also #92308)
possibly deprecate the deprecated directive and replace it with deprecated-removed

Vorherrschende Sprache: Python
Sterne: 77.2k
Forks: 36k
Ø Merge: 1 T. 9 Std.
Gemergte PRs (30 T.): 558

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus python/cpython

docs: Zipfile contains a 13-years outdated warning regarding path sanitization Offen

docs pending

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100

python/cpython#157339 · 10 Kommentare · Erstellt am 11.9.2026
pydoc HTML output is not responsive and has no viewport meta in released versions Offen

stdlib type-feature

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100

python/cpython#155601 · 2 Kommentare · Erstellt am 12.8.2026
`zipfile.ZipFile.writestr()` raises `AttributeError` instead of accepting `os.PathLike` objects (e.g. `pathlib.Path`) Offen

stdlib type-feature

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100

python/cpython#153771 · 5 Kommentare · Erstellt am 15.7.2026
BOLT-WARNING: specifying numeric value "1" for option -icf is deprecated Offen

build type-bug

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100

python/cpython#149708 · 1 Kommentar · Erstellt am 12.5.2026
Expose message ID list from `ReferencesHeader` Offen

stdlib topic-email type-feature

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100

python/cpython#148797 · 3 Kommentare · Erstellt am 20.4.2026

Alle Issues in python/cpython