Docs for `sc.tl.filter_rank_genes_group()` missing argument descriptions
Open
Nobody has claimed this yet.
Area - Documentation 📒
- Dominant language
- Python
- Stars
- 2.6k
- Forks
- 779
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 27
Description
- I have checked that this issue has not already been reported.
- I have confirmed this bug exists on the latest version of scanpy.
- (optional) I have confirmed this bug exists on the master branch of scanpy.
The docs for sc.tl.filter_rank_genes_group() are incomplete, specifically missing argument descriptions https://scanpy.readthedocs.io/en/stable/generated/scanpy.tl.filter_rank_genes_groups.html.
Not sure if these are missing from the code or just haven't rendered for some reason.
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 generated documentation page for scanpy.tl.filter_rank_genes_groups() and compare its rendered argument list with the function's source documentation. Check whether the descriptions are absent at the source or lost during rendering, then verify that all argument descriptions appear on the generated page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100