scverse / scverse/scverse-misc
Common documentation/docstring related utlities
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 2
- Avg merge
- 11h 10m
- Merged PRs (30d)
- 13
Description
Description of feature
I think quite many of our packages use a method to inject specific parameters into docstrings to DRY them. Maybe scverse-misc could provide general utilities for docstring handling or more broadly documentation.
We could discuss whether some of these should go into the upcoming scverse-doc (scanpy-doc) instead.
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 files, tests, or entry points are named. First clarify which docstring-injection utilities belong in scverse-misc versus the proposed scverse-doc (scanpy-doc), then define the supported use cases and acceptance criteria before implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100