Argument Clinic How-To needs more examples
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 2.1k
- Fork
- 1k
- Merge medio
- 2g 12h
- PR unite (30g)
- 12
Descrizione
Documentation
Currently, the example for AC How-To is the method _pickle.Pickler.dump. I think it is not proper since it cannot cover all cases and makes readers confused. A more intuitive example should be considered to replace the current one.
Linked PRs
- python/cpython#106800
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.
Direzione di ricerca
Leggi l'Argument Clinic How-To ed esamina il suo esempio attuale di _pickle.Pickler.dump. Confrontalo con i casi che la guida deve coprire, quindi sostituisci l'esempio con uno più intuitivo oppure aggiungi esempi, se opportuno; la documentazione non dovrebbe più confondere i lettori e dovrebbe riflettere la modifica concordata nel PR collegato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 25/100