NVIDIA / NVIDIA/cuda-python

[BUG] Inner lists in `cuda.bindings` API reference are dropped

Abierto
#770 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

bug cuda.bindings documentation P1
Lenguaje dominante
Cython
Estrellas
3.4k
Forks
329
Merge medio
1 d 23 h
PR fusionados (30 d)
116

Descripción

Taking NVRTC's --gpu-architecture option as example:

  • This is the generated docs (by parsing Doxygen docstrings with an internal tool)
Image
  • This is the public docs (the list is too long, so I only show a portion of it)
Image
  • 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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Compara la referencia de API generada con la documentación pública y con la estructura de listas anidadas mostrada en el docstring de nvrtc.h. Rastrea la herramienta interna de análisis de Doxygen para encontrar dónde se descartan las listas anidadas y, a continuación, verifica que la referencia de la CUDA API conserve las listas internas.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
c
Área
documentation
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
48/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.