scverse / scanpy

Single-cell analysis in Python. Scales to >1M cells.
https://scanpy.readthedocs.io
BSD 3-Clause "New" or "Revised" License
1.93k stars 604 forks source link

Documentation typo for scanpy.pp.filter_cells #3332

Open fionaEyoung opened 1 month ago

fionaEyoung commented 1 month ago

The function documentation for filter_cells has the following under "Returns":

number_per_cell : ndarray Depending on what was thresholded (counts or genes), the array stores n_counts or n_cells per gene.

I have a feeling this is copied from filter_genes and should read

the array stores n_counts or n_cells per cell.

If not, perhaps more explanation is needed as to why this output is identical to the filter_genes function.