[DOC]: C API doc strings don't always make sense with python bindings
Offen
Dieses Issue hat noch niemand übernommen.
blocked
cuda.bindings
documentation
enhancement
- Vorherrschende Sprache
- Cython
- Sterne
- 3.4k
- Forks
- 329
- Ø Merge
- 1 T. 23 Std.
- Gemergte PRs (30 T.)
- 116
Beschreibung
Is this a duplicate?
- I confirmed there appear to be no duplicate issues for this bug and that I agree to the Code of Conduct
Is this for new documentation, or an update to existing docs?
Update
Describe the incorrect/future/missing documentation
If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.
No response
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, die Python-seitige Dokumentation zu finden, die die im Screenshot gezeigten C-API-Strings wiederverwendet, und vergleiche anschließend ihre Parameter- und Rückgabebeschreibungen mit dem Verhalten des Bindings. Erledigt ist die Aufgabe, wenn die betroffenen Dokumente zurückgegebene Listen und Python-Werte statt benutzergesteuerter C-Argumente oder NULL beschreiben und die Formatierung korrigiert ist.
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