Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

PEP 1: Replace/Update the "How to teach this" with "Documentation Updates"

Offen
  • Stimmt etwas nicht?
#4,040 4 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
50/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
python
Bereich
documentation

Rechercherichtung

Beginne damit, das PEP-Template oder die Anleitung zu finden, in der der Abschnitt „How to teach this“ definiert ist. Aktualisiere ihn so, dass „Documentation Updates“ verwendet wird, und füge konkrete Anregungen für die Dokumentation von Features oder Änderungen hinzu. Überprüfe anschließend die aktuelle Verwendung von PEPs auf Konsistenz.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

I would like to suggest an update to the "How to teach this" section in PEPs to "Documentation Updates".

As part of proposing new features or changes, it would be great if PEP authors also take into consideration of what docs need to be produced/updated.

For example, would the PEP require changes to the how-to doc? Will there be new tutorial section written? What other areas of Python docs need to be updated to accommodate this new change? Are there existing docs that will become outdated and need changing? I think all of these should be taken into consideration when proposing changes so that we can have up to date documentation alongside the changes.

I think the "How to teach this" section meant to address this, but in practise I find the use of this section has been inconsistent, so I recommend making the section be more explicit about documentation artifacts to accompany the feature/change.

I also find some of the "How to teach this" in current PEPs sometimes are sounding can sound hypothetical. I'm seeing phrases like "Teachers could say so and so to students".

Instead of imagining what teachers could say, I think it would be more helpful to come up with concrete plan of what documentation can be produced to assist users in learning and adopting the feature/change.

Vorherrschende Sprache
reStructuredText
Sterne
5k
Forks
1.8k
Ø Merge
1 T. 9 Std.
Gemergte PRs (30 T.)
29

Entwicklungsumgebung

Erste Schritte

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

Mehr aus python/peps

Alle Issues in python/peps

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.