[BUG] Inner lists in `cuda.bindings` API reference are dropped
Aperta
Nessuno ha ancora preso questa issue.
bug
cuda.bindings
documentation
P1
- Lingua principale
- Cython
- Stelle
- 3.4k
- Fork
- 329
- Merge medio
- 1g 23h
- PR unite (30g)
- 116
Descrizione
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.
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
Confronta il riferimento API generato con la documentazione pubblica e con la struttura di elenchi annidati mostrata nel docstring di nvrtc.h. Segui lo strumento interno di parsing di Doxygen per individuare il punto in cui gli elenchi annidati vengono eliminati, quindi verifica che il riferimento della CUDA API conservi gli elenchi interni.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- c
- Ambito
- documentation
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 48/100