Skip to content

docs: fix API docstrings that don'tt render and broken example README - #229

Merged
sbillinge merged 1 commit into
diffpy:mainfrom
cadenmyers13:docs-api-rendering-fixes
Oct 15, 2026
Merged

sbillinge merged 1 commit into
diffpy:mainfrom
cadenmyers13:docs-api-rendering-fixes

docs: fix API docstrings that don'tt render and broken example README

e27a698
Select commit
Loading
Failed to load commit list.
Codecov / codecov/project succeeded Oct 15, 2026 in 1s

84.87% (+13.24%) compared to a9eae82

View this Pull Request on Codecov

84.87% (+13.24%) compared to a9eae82

Details

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.87%. Comparing base (a9eae82) to head (e27a698).
⚠️ Report is 25 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main     #229       +/-   ##
===========================================
+ Coverage   71.63%   84.87%   +13.24%     
===========================================
  Files          25       43       +18     
  Lines        3437     4861     +1424     
===========================================
+ Hits         2462     4126     +1664     
+ Misses        975      735      -240     

see 22 files with indirect coverage changes

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