scanpy
scanpy copied to clipboard
Plotting functions documentation issues
Hey there,
Found out today (from a question on discourse) that some plotting documentation is misleading. The 'return' section for heatmap
, tracksplot
and potentially other functions as well should be fixed in two ways:
- They type should be dictionary and not list, and the potential keys for the axes should be documented
- The documentation should state that the dictionary is returned only if
show=False
is passed.
The documentation is also misleading for other functions in scanpy/plotting/_anndata.py
, where some functions don't mention the effects of show
or ax is not None
.
hi @yotamcons ,
thanks a lot for the feedback, we'd really appreciate if you could submit a PR fixing these parts of the documentations that needs to be updated. Happy to support if you need any help,
Thank you!
There is also a small typo in the tl.tsne
documentation.
I think the return type should be
X_tsne np.ndarray (adata.obsm dtype float)
right now it states that the array is stored at adata.obs.
hi @yotamcons ,
thanks a lot for the feedback, we'd really appreciate if you could submit a PR fixing these parts of the documentations that needs to be updated. Happy to support if you need any help,
Thank you!
Would love to starting November, ping me if thats still relevant
@yotamcons please do!