Skip to content

docs: add docstrings to BaseTransformation.inverse() and to_affine_ma… - #1169

Open
Taimoor092 wants to merge 2 commits into
scverse:mainfrom
Taimoor092:Taimoor092-patch-1
Open

docs: add docstrings to BaseTransformation.inverse() and to_affine_ma…#1169
Taimoor092 wants to merge 2 commits into
scverse:mainfrom
Taimoor092:Taimoor092-patch-1

Conversation

@Taimoor092

Copy link
Copy Markdown

Closes #836

Changes

  • Added NumPy-style docstring to BaseTransformation.inverse() describing the return value
  • Added NumPy-style docstring to BaseTransformation.to_affine_matrix() describing parameters and return value

Both methods are abstract and previously had no documentation beyond the method signature.

Taimoor092 and others added 2 commits July 27, 2026 20:24
…trix()

Addresses issue scverse#836 - adds missing docstrings to abstract methods in BaseTransformation
@codecov

codecov Bot commented Jul 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.44%. Comparing base (eb4fb3d) to head (0f180b2).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1169   +/-   ##
=======================================
  Coverage   92.44%   92.44%           
=======================================
  Files          51       51           
  Lines        7820     7820           
=======================================
  Hits         7229     7229           
  Misses        591      591           
Files with missing lines Coverage Δ
src/spatialdata/transformations/transformations.py 91.08% <ø> (ø)
🚀 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.

Add missing docstrings

1 participant