Skip to content

docs: correct img_res_key references in spatial plotting - #1290

Open
Georicl wants to merge 1 commit into
scverse:mainfrom
Georicl:test/fix-884-img-res-key-docs
Open

Georicl wants to merge 1 commit into
scverse:mainfrom
Georicl:test/fix-884-img-res-key-docs

Conversation

@Georicl

@Georicl Georicl commented Sep 13, 2026

Copy link
Copy Markdown

Description

Correct three docstring references from img_key to img_res_key in spatial plotting documentation, including the shared scale_factor description, to match the existing API.

How has this been tested?

  • Passed pre-commit checks for both changed files.
  • Built the complete documentation with Sphinx warnings treated as errors (-W); zero warnings.
  • Verified the generated spatial_scatter and spatial_segment API pages and their parameter signatures.

Closes

Closes #884.

@codecov

codecov Bot commented Sep 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.44%. Comparing base (8286274) to head (73e4344).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1290   +/-   ##
=======================================
  Coverage   78.44%   78.44%           
=======================================
  Files          63       63           
  Lines        9532     9532           
  Branches     1594     1594           
=======================================
  Hits         7477     7477           
  Misses       1489     1489           
  Partials      566      566           
Files with missing lines Coverage Δ
src/squidpy/_docs.py 95.34% <ø> (ø)
src/squidpy/pl/_spatial.py 92.85% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

[doc improvment] inconsistent usage of img_key and img_res_key in code base

1 participant