Skip to content

Fixed several doctoring issues - #16

Merged
spcarte merged 1 commit into
developfrom
Fix-auto-api-documentation
Jan 12, 2026
Merged

spcarte merged 1 commit into
developfrom
Fix-auto-api-documentation

Conversation

@spcarte

@spcarte spcarte commented Jan 11, 2026

Copy link
Copy Markdown
Collaborator

Fixed several issues in the function/method docstrings that caused issues in the sphinx-autoapi documentation build.

@spcarte
spcarte merged commit 27bbd22 into develop Jan 12, 2026
2 checks passed
@codecov

codecov Bot commented Jan 12, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 0% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 52.12%. Comparing base (58194bf) to head (ca61627).
⚠️ Report is 2 commits behind head on develop.

Files with missing lines Patch % Lines
src/forcefinder/core/auto_regularization.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop      #16      +/-   ##
===========================================
+ Coverage    51.15%   52.12%   +0.96%     
===========================================
  Files           10       10              
  Lines         2160     2116      -44     
===========================================
- Hits          1105     1103       -2     
+ Misses        1055     1013      -42     
Flag Coverage Δ
15/merge ?
16/merge 52.12% <0.00%> (?)
develop ?

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@spcarte
spcarte deleted the Fix-auto-api-documentation branch January 12, 2026 00:01
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.

1 participant