Documentation of spatial_scatter
Open
Nobody has claimed this yet.
doc
maint :building_construction:
- Dominant language
- Python
- Stars
- 598
- Forks
- 121
- Avg merge
- 3d 11h
- Merged PRs (30d)
- 3
Description
The documentation for legend_loc in spatial_scatter refers to matplotlib.legend.Legend which is wrong I think. The legend_loc variable is passed to the scanpy function _add_categorical_legend (code), so it seems like the only valid options for legend_loc are ["right margin", "on data"] which should be specified in the documentation.
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 src/squidpy/_docs.py lines 222-223 and compare the legend_loc description with Scanpy's _add_categorical_legend implementation in scanplots.py. Update the parameter documentation to describe the supported values, then run the relevant documentation or test checks to confirm the rendered API reference is correct.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100