scverse / scverse/fast-array-utils
Document `numba` sparse plugin types
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15
- Forks
- 5
- Avg merge
- 10h 33m
- Merged PRs (30d)
- 9
Description
I don't see this in the docs at the moment? Even just a note in typing or something. Like doing
@njit
def my_op(
mat: CSBase
....
)
should be documented, right?
Contributor guide
No contributing guide indexed for this repository
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 typing documentation page and review how existing types are described. Document the sparse plugin types, including the CSBase annotation example inside an @njit function, so users can find and understand this usage in the docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 74/100