Argument clinic: outdated tutorial
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 2.1k
- Fork
- 1k
- Merge medio
- 2g 12h
- PR unite (30g)
- 12
Descrizione
Documentation
The tutorial for Argument Clinic in the devguide contains an outdated section. It still describes the early implementation that used to generate calls to PyArg_ParseTuple*() functions. This is no longer the case.
The affected section starts with "First, ensure both places use the same argument-parsing function." and goes for a few paragraphs until "If any of these items differ in any way, adjust your Argument Clinic function specification and rerun Tools/clinic/clinic.py until they are the same."
Given that the output is now very different, this is quite confusing to read. The section probably needs to be completely rewritten.
CC @AlexWaygood @erlend-aasland
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
Apri il tutorial di Argument Clinic collegato e rivedi la sezione che inizia con «First, ensure both places use the same argument-parsing function.». Confronta le sue affermazioni con l’output e il comportamento attuali di Tools/clinic/clinic.py. La documentazione sarà completa quando questa sezione descriverà accuratamente l’implementazione attuale e non presenterà più il workflow obsoleto di PyArg_ParseTuple*().
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100