Figure out how to document anonymous structs/unions
Open
Nobody has claimed this yet.
cuda.bindings
documentation
P2
- Dominant language
- Cython
- Stars
- 3.4k
- Forks
- 329
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 116
Description
Ex: https://nvidia.github.io/cuda-python/module/driver.html#cuda.bindings.driver.CUasyncNotificationInfo
The member info is of type anon_union2, which is undocumented.
Setting this to P2 without a milestone, as people can always refer to the C API reference. But we don't want to lose track of this.
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
Start with the linked CUasyncNotificationInfo API documentation and inspect how its info member is currently rendered. Trace the documentation path for the anonymous anon_union2 type; done means the anonymous struct or union and its members are documented rather than omitted.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100