Skip to content

docs: add adjustment family doctest examples#800

Open
EKtheSage wants to merge 2 commits into
casact:mainfrom
EKtheSage:docs/704-adjustment-family-examples
Open

docs: add adjustment family doctest examples#800
EKtheSage wants to merge 2 commits into
casact:mainfrom
EKtheSage:docs/704-adjustment-family-examples

Conversation

@EKtheSage
Copy link
Copy Markdown
Contributor

@EKtheSage EKtheSage commented May 16, 2026

Summary: Add Sphinx doctest examples for correlation, BERQ/Sherman, bootstrap, parallelogram, trend, constant development, and Munich adjustment docs. Split from the larger #792 work and intentionally excludes .github/workflows/sync-main-to-docs.yml. Refs #704


Note

Low Risk
Low risk: changes are limited to docstring updates (Sphinx doctest examples and minor wording/formatting tweaks) with no intended runtime behavior changes.

Overview
Adds Sphinx doctest-ready Examples blocks to several public APIs (BerquistSherman, BootstrapODPSample, ParallelogramOLF, Trend, DevelopmentCorrelation/ValuationCorrelation, DevelopmentConstant, MunichAdjustment) to demonstrate parameter effects with reproducible outputs.

Also makes small docstring cleanups (parameter wording/formatting and a minor whitespace fix) to improve generated documentation consistency.

Reviewed by Cursor Bugbot for commit 1b4b2fd. Bugbot is set up for automated code reviews on this repo. Configure here.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 843a7b5. Configure here.

Comment thread chainladder/development/constant.py Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented May 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.23%. Comparing base (72b270c) to head (1b4b2fd).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #800   +/-   ##
=======================================
  Coverage   86.23%   86.23%           
=======================================
  Files          86       86           
  Lines        4947     4947           
  Branches      643      643           
=======================================
  Hits         4266     4266           
  Misses        484      484           
  Partials      197      197           
Flag Coverage Δ
unittests 86.23% <100.00%> (ø)

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.

@henrydingliu
Copy link
Copy Markdown
Collaborator

please pull main

@EKtheSage EKtheSage force-pushed the docs/704-adjustment-family-examples branch from f9ed4f9 to 1b4b2fd Compare May 17, 2026 04:20
@henrydingliu
Copy link
Copy Markdown
Collaborator

still seeing reversions on newer commits from main

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.

2 participants