PEP 1: Replace/Update the "How to teach this" with "Documentation Updates"
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 50/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Inizia individuando il template o le linee guida del PEP che definiscono la sezione «How to teach this». Aggiornala in modo che utilizzi «Documentation Updates» e fornisci indicazioni concrete per documentare funzionalità o modifiche, quindi verifica la coerenza dell’uso attuale dei PEP.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- reStructuredText
- Stelle
- 5k
- Fork
- 1.8k
- Merge medio
- 2g 4h
- PR unite (30g)
- 25
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di python/peps
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
New PEP Editors? Apertameta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
-
infra
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 48/100