docs: add doctest Examples for correlation, Munich, tails, adjustments, workflow, and utils#792
Conversation
On every push to main, GitHub Actions automatically merges main into docs/great-docs-prototype so the docs branch stays current with all code changes while keeping its doc-engine files intact.
…amily Add Sphinx .. testsetup:: / .. testcode:: / .. testoutput:: blocks showing parameter effects for DevelopmentCorrelation, ValuationCorrelation, DevelopmentConstant, MunichAdjustment, CaseOutstanding, BootstrapODPSample, BerquistSherman, and Trend (axis, piecewise trends, compound Trend with CapeCod on clrd). Use random_state=42 in BootstrapODPSample example. Parameters and Attributes sections are unchanged. Co-authored-by: Cursor <cursoragent@cursor.com>
…ramOLF Add Sphinx parameter-effect Examples for GridSearch, Pipeline, VotingChainladder (weights), read_pickle, minimum, maximum, read_json, concat, TailCurve, TailBondy, TailClark, and ParallelogramOLF. Replace PatsyFormula toy-DataFrame example with genins-based TweedieGLM and DevelopmentML pipeline demonstrations. Co-authored-by: Cursor <cursoragent@cursor.com>
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 ce197a6. Configure here.
| git config user.email "github-actions[bot]@users.noreply.github.com" | ||
| git checkout docs/great-docs-prototype | ||
| git merge origin/main --no-edit -m "chore: sync main into docs/great-docs-prototype" | ||
| git push origin docs/great-docs-prototype |
There was a problem hiding this comment.
Unrelated CI workflow file included in docs PR
Low Severity
The new sync-main-to-docs.yml workflow file is not mentioned anywhere in the PR description's "Files changed" table, which exclusively lists Python source files. This workflow — which auto-merges main into docs/great-docs-prototype on every push — is unrelated to adding doctest examples and appears to have been accidentally included in this documentation-focused PR.
Reviewed by Cursor Bugbot for commit ce197a6. Configure here.
|
echoing @kennethshsu 's concerns from #786 , this is a whale of a PR. |
|
Hi @EKtheSage, this is a big PR too. I would encourage smaller PRs going forward. I think 2-3 methods max for the docstrings improvements. Can you resolve the merge conflict with another commit and I will help review this? |
|
Closing as superseded by smaller scoped PRs for #704: #800, #801, #803, and #804 cover the adjustment family, tails, workflow, and utility work from this branch. The replacement PRs are rebased from current main, scoped by subsystem, and intentionally exclude .github/workflows/sync-main-to-docs.yml. |


Summary
Examplessections with.. testsetup::,.. testcode::, and.. testoutput::Sphinx doctest directives to 14 files across the codebasecl.load_sample()data and reproducibleround()outputBerquistSherman,BootstrapODPSample,ParallelogramOLF,TrendAdjustment,DevelopmentCorrelation,ValuationCorrelation,ConstantDevelopment,MunichChainladder,CaseOutstanding,BondyTail,ClarkTail,TailCurve,GridSearch,VotingChainladder, and utility functionsFiles changed
berqsherm.py,bootstrap.py,parallelogram.py,trend.pycorrelation.pyconstant.py,munich.py,outstanding.pybondy.py,clark.py,curve.pyutility_functions.pygridsearch.py,voting.pyTest plan
.. testoutput::blocks match actual estimator outputimport chainladderintestsetup, other imports intestcode) is consistentNote
Medium Risk
Mostly documentation-only doctest additions, but it also introduces a GitHub Action that auto-merges and pushes
mainintodocs/great-docs-prototype, which could cause unexpected branch updates or merge conflicts if misconfigured.Overview
Adds extensive Sphinx doctest
Examplesblocks to a wide set of estimators/utilities (adjustments, correlation, development, tails, workflow, andutility_functions) to demonstrate parameter effects with reproducible outputs.Introduces a new GitHub Actions workflow (
sync-main-to-docs.yml) that, on every push tomain, checks outdocs/great-docs-prototype, mergesorigin/maininto it, and pushes the result back to the remote branch.Reviewed by Cursor Bugbot for commit ce197a6. Bugbot is set up for automated code reviews on this repo. Configure here.