Skip to content

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

Draft
Zethson wants to merge 3 commits into
mainfrom
fix-2116-norm-docs
Draft

docs: document norm parameter for embedding scatter plots#4297
Zethson wants to merge 3 commits into
mainfrom
fix-2116-norm-docs

Conversation

@Zethson

@Zethson Zethson commented Aug 14, 2026

Copy link
Copy Markdown
Member

Summary

  • norm was missing from the docstrings of sc.pl.embedding and related functions (umap, pca, tsne, embedding_density, ...) even though it's an accepted parameter, since doc_vbound_percentile (used by these functions) didn't document it while the separate doc_vboundnorm (used elsewhere) did.
  • Added the norm entry to doc_vbound_percentile.

Closes #2116

@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.
⚠️ Please upload report for BASE (main@9df46b4). Learn more about missing BASE report.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4297   +/-   ##
=======================================
  Coverage        ?   79.29%           
=======================================
  Files           ?      128           
  Lines           ?    13479           
  Branches        ?        0           
=======================================
  Hits            ?    10688           
  Misses          ?     2791           
  Partials        ?        0           
Flag Coverage Δ
hatch-test.low-vers 77.52% <ø> (?)
hatch-test.pre 79.16% <ø> (?)

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% <ø> (ø)

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

1 participant