Skip to content

docs: Remove duplicated 'layer' parameter from PCA documentation#4202

Open
AlbertoFabbri93 wants to merge 3 commits into
scverse:mainfrom
AlbertoFabbri93:patch-1
Open

docs: Remove duplicated 'layer' parameter from PCA documentation#4202
AlbertoFabbri93 wants to merge 3 commits into
scverse:mainfrom
AlbertoFabbri93:patch-1

Conversation

@AlbertoFabbri93

Copy link
Copy Markdown

Fix small documentation error: the 'layer' parameter is documented twice for the PCA preprocessing function.

The 'layer' parameter is documented twice in the PCA function documentation.
@codecov

codecov Bot commented Jul 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.92%. Comparing base (7df9ad6) to head (7583dfb).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4202   +/-   ##
=======================================
  Coverage   79.91%   79.92%           
=======================================
  Files         121      121           
  Lines       12949    12949           
=======================================
+ Hits        10348    10349    +1     
+ Misses       2601     2600    -1     
Flag Coverage Δ
hatch-test.low-vers 79.04% <ø> (ø)
hatch-test.pre 79.87% <ø> (+<0.01%) ⬆️

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

Files with missing lines Coverage Δ
src/scanpy/preprocessing/_pca/__init__.py 91.92% <ø> (ø)

... and 1 file with indirect coverage changes

@Zethson Zethson added this to the 1.12.3 milestone Jul 8, 2026
@Zethson

Zethson commented Jul 8, 2026

Copy link
Copy Markdown
Member

Great! If you'd like, you could add a small release note to be credited later when we make a release. Otherwise, I'll get this in as is.

@Zethson Zethson changed the title Remove duplicated 'layer' parameter from PCA documentation docs: Remove duplicated 'layer' parameter from PCA documentation Jul 8, 2026
@AlbertoFabbri93

Copy link
Copy Markdown
Author

Nah, it's okay. You can merge as is.

@Zethson

Zethson commented Jul 9, 2026

Copy link
Copy Markdown
Member
generating indices... /home/docs/checkouts/readthedocs.org/user_builds/icb-scanpy/checkouts/4202/docs/release-notes/1.6.0.md:44: WARNING: unknown document: 'anndata:concatenation' [ref.doc]

shouldn't be your fault. I'll take care of this soon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants