PEP 1: Replace/Update the "How to teach this" with "Documentation Updates"
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- reStructuredText
- Sterne
- 5k
- Forks
- 1.8k
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 25
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
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.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 50/100