scanpy icon indicating copy to clipboard operation
scanpy copied to clipboard

Plotting functions documentation issues

Open yotamcons opened this issue 1 year ago • 3 comments

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:

  1. They type should be dictionary and not list, and the potential keys for the axes should be documented
  2. 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.

yotamcons avatar Jul 28 '22 12:07 yotamcons

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!

giovp avatar Aug 10 '22 11:08 giovp

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.

maflot avatar Aug 16 '22 08:08 maflot

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 avatar Aug 31 '22 16:08 yotamcons

@yotamcons please do!

Zethson avatar Jan 16 '23 11:01 Zethson