[BUG] Inner lists in `cuda.bindings` API reference are dropped
Open
Nobody has claimed this yet.
bug
cuda.bindings
documentation
P1
- Dominant language
- Cython
- Stars
- 3.4k
- Forks
- 329
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the generated API reference with the public docs and the nested list structure shown in the nvrtc.h docstring. Trace the internal Doxygen parsing tool to find where nested lists are dropped, then verify that the CUDA API reference preserves the inner lists.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100