Stop repeating input/output type info in docstrings
Open
Nobody has claimed this yet.
cuda.core
documentation
P1
- Dominant language
- Cython
- Stars
- 3.4k
- Forks
- 329
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 116
Description
I think Sphinx is able to figure out the types and keep them in the document by inspecting the typing info, which going forward should be our source of truth (https://github.com/NVIDIA/cuda-python/issues/312#issue-2746694448). We should not repeat ourselves.
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
No file or test is named. Start by reading the docstrings and typing definitions covered by this issue, then check the generated Sphinx documentation; done means redundant input/output type declarations are removed while the types remain present in the rendered documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100