The `.uns` output for `scanpy.pp.highly_variable_genes` is not documented
Open
Beginner friendly
Nobody has claimed this yet.
Triage 🩺
- Dominant language
- Python
- Stars
- 2.6k
- Forks
- 779
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 27
Description
What kind of feature would you like to request?
Improved documentation or error message?
Please describe your wishes
Very minor but the documentation for the highly_variable_genes function does not mention the flavor information stored in .uns["hvg"]. This is used/expected by downstream functions (plotting) so would be good to include.
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 at the documentation for scanpy.pp.highly_variable_genes and review how its output is described. Document the flavor information stored in .uns["hvg"], including that downstream plotting functions use or expect it.
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
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 74/100