[BUG] Inner lists in `cuda.bindings` API reference are dropped
Ouverte
Personne n'a encore pris cette issue.
bug
cuda.bindings
documentation
P1
- Langage dominant
- Cython
- Étoiles
- 3.4k
- Forks
- 329
- Merge moyen
- 1 j 23 h
- PR mergées (30 j)
- 116
Description
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Comparez la référence API générée avec la documentation publique et la structure de listes imbriquées présentée dans le docstring de nvrtc.h. Suivez l’outil interne d’analyse de Doxygen pour trouver où les listes imbriquées sont supprimées, puis vérifiez que la référence de la CUDA API préserve les listes internes.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- c
- Domaine
- documentation
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 48/100