Skip to content

docs: document norm parameter for embedding scatter plots - #4297

Merged
Zethson merged 5 commits into
mainfrom
fix-2116-norm-docs
Nov 17, 2026
Merged

Zethson merged 5 commits into
mainfrom
fix-2116-norm-docs

Conversation

@Zethson

@Zethson Zethson commented Aug 14, 2026 •

Copy link
Copy Markdown
Member

Closes #2116.
Adds the missing norm entry to doc_vbound_percentile, so sc.pl.embedding, its wrappers (umap, pca, tsne, ...) and sc.pl.embedding_density now document a parameter they already accepted.

@Zethson Zethson added this to the 1.12.4 milestone Aug 14, 2026
@Zethson
Zethson marked this pull request as draft August 14, 2026 11:32
@codecov

codecov Bot commented Aug 14, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.11%. Comparing base (3962176) to head (e9bd289).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4297   +/-   ##
=======================================
  Coverage   85.11%   85.11%           
=======================================
  Files         140      140           
  Lines       12523    12523           
=======================================
  Hits        10659    10659           
  Misses       1864     1864           
Flag Coverage Δ
hatch-test.low-vers 80.34% <ø> (ø)
hatch-test.pre 84.89% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
src/scanpy/plotting/legacy/_docs.py 100.00% <ø> (ø)

@flying-sheep flying-sheep modified the milestones: 1.12.4, 1.12.5 Aug 27, 2026
@flying-sheep flying-sheep modified the milestones: 1.12.5, 1.12.6, 1.12.7 Oct 29, 2026
The PR title type is docs, so the fragment belongs in 4297.docs.md.
As 4297.fix.md towncrier would have listed it under Bug fixes in 1.13.1.
@Zethson
Zethson marked this pull request as ready for review November 16, 2026 10:13
@Zethson
Zethson merged commit 5c7d839 into main Nov 17, 2026
18 checks passed
@Zethson
Zethson deleted the fix-2116-norm-docs branch November 17, 2026 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

missing arg in docs for scanpy embedding

2 participants