search

scverse / squidpy

Spatial Single Cell Analysis in Python
https://squidpy.readthedocs.io/en/stable/
BSD 3-Clause "New" or "Revised" License
428 stars 79 forks source link

Documentation of spatial_scatter #844

Open psl-schaefer opened 3 months ago

psl-schaefer commented 3 months ago

https://github.com/scverse/squidpy/blob/16a9885976e24778664c81c05a9b592b2bd4a237/src/squidpy/_docs.py#L222-L223

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.

giovp commented 3 months ago

that is correct! Thank you @schae211 for this, would really appreciate if you could submit a PR clarifying this line in the docs, would be super useful!