Skip to content

Commit 87bc421

Browse files
flying-sheepmeeseeksmachine
authored andcommitted
Backport PR scverse#3989: docs: specify sc.tl.score_genes array type support
1 parent 0ae40fe commit 87bc421

3 files changed

Lines changed: 7 additions & 1 deletion

File tree

docs/api/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Additional functionality is available in the broader {doc}`ecosystem <../ecosyst
1414
## Array type support
1515

1616
Different APIs have different levels of support for array types,
17-
and this page lists the supported array types for each function:
17+
and this page lists the supported array types for each function
18+
(⚡ indicates support of the type as chunk in a dask {class}`~dask.array.Array`):
1819

1920
```{eval-rst}
2021
.. array-support:: all

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,7 @@
196196
"tl.louvain": (["np", "sp"], []), # only uses graph in obsp
197197
"tl.paga": (["np", "sp"], []),
198198
"tl.rank_genes_groups": (["np", "sp"], []),
199+
"tl.score_genes": (["np", "sp"], []),
199200
"tl.tsne": (["np", "sp"], []),
200201
"tl.umap": (["np", "sp"], []),
201202
}

src/scanpy/tools/_score_genes.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ def score_genes( # noqa: PLR0913
7676
programs and cell scores" in materials and methods) and has been implemented
7777
for Scanpy by Davide Cittaro.
7878
79+
.. array-support:: tl.score_genes
80+
7981
Parameters
8082
----------
8183
adata
@@ -273,6 +275,8 @@ def score_genes_cell_cycle(
273275
scores and assigns a cell cycle phase (G1, S or G2M). See
274276
:func:`~scanpy.tl.score_genes` for more explanation.
275277
278+
.. array-support:: tl.score_genes
279+
276280
Parameters
277281
----------
278282
adata

0 commit comments

Comments
 (0)