[BUG] Inner lists in `cuda.bindings` API reference are dropped
Offen
Dieses Issue hat noch niemand übernommen.
bug
cuda.bindings
documentation
P1
- Vorherrschende Sprache
- Cython
- Sterne
- 3.4k
- Forks
- 329
- Ø Merge
- 1 T. 21 Std.
- Gemergte PRs (30 T.)
- 113
Beschreibung
Taking NVRTC's --gpu-architecture option as example:
- This is the generated docs (by parsing Doxygen docstrings with an internal tool)
- This is the public docs (the list is too long, so I only show a portion of it)
- This is the docstring from
nvrtc.h(also truncated):
* The valid compiler options are:
*
* - Compilation targets
* - \c --gpu-architecture=\<arch\> (\c -arch)
*
* Specify the name of the class of GPU architectures for which the
* input must be compiled.\n
* - Valid <c>\<arch\></c>s:
* - \c compute_50
* - \c compute_52
* - \c compute_53
* - \c compute_60
* - \c compute_61
* - \c compute_62
* - \c compute_70
* - \c compute_72
* - \c compute_75
* - \c compute_80
* - \c compute_86
* - \c compute_87
* - \c compute_89
We can see the inner lists are not parsed.
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
Vergleiche die generierte API-Referenz mit der öffentlichen Dokumentation und der verschachtelten Listenstruktur, die im Docstring von nvrtc.h dargestellt ist. Verfolge das interne Doxygen-Parsing-Tool, um herauszufinden, wo verschachtelte Listen verworfen werden, und überprüfe anschließend, dass die CUDA API-Referenz die inneren Listen beibehält.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- c
- Bereich
- documentation
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100