docs: add adjustment family doctest examples#800
Open
EKtheSage wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ 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.
Closed
3 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Collaborator
|
please pull main |
f9ed4f9 to
1b4b2fd
Compare
Collaborator
|
still seeing reversions on newer commits from main |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

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.