Argument clinic: outdated tutorial
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 2.1k
- Forks
- 1k
- Ø Merge
- 2 T. 12 Std.
- Gemergte PRs (30 T.)
- 12
Beschreibung
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
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
Öffne das verlinkte Argument-Clinic-Tutorial und überprüfe den Abschnitt, der mit „First, ensure both places use the same argument-parsing function.“ beginnt. Vergleiche seine Aussagen mit der aktuellen Ausgabe und dem aktuellen Verhalten von Tools/clinic/clinic.py. Die Dokumentation ist fertig, wenn dieser Abschnitt die aktuelle Implementierung korrekt beschreibt und den veralteten PyArg_ParseTuple*()-Workflow nicht mehr darstellt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100