Update API docs

[forman]

[Description of PR]

Checklist (strike out non-applicable):

• Changes documented in CHANGES.md
• Related issue exists and is referred to in the PR description and CHANGES.md
• Added docstrings and API docs for any new/modified user-facing classes and functions
• Changes/features documented in docs/*
• Unit-tests adapted/added for changes/features
• Test coverage remains or increases (target 100%)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.13%. Comparing base (9b8d5f4) to head (650efd6).
Report is 4 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #14      +/-   ##
==========================================
+ Coverage   96.11%   96.13%   +0.01%     
==========================================
  Files          51       51              
  Lines        1804     1813       +9     
  Branches      240      240              
==========================================
+ Hits         1734     1743       +9     
  Misses         35       35              
  Partials       35       35              

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