Various docstring fixes#1020
Open
henrydingliu wants to merge 97 commits into
Open
Conversation
docs: add docstrings for Triangle broadcast_axis, copy, reindex (#970)
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
docs: add docstrings for Triangle exp, log, sqrt, round (#970)
docs: add docstrings for Triangle head, tail, sort_index (#970)
docs: add docstrings for Triangle compute and pipe (#970)
…) (#960) The Sample Datasets section listed 18 datasets in a hand-maintained markdown table that had drifted out of date; the package now bundles 46. Replace the static table with a live cl.list_samples() call so the docs can no longer drift from the manifest. model_diagnostics was added to the public API but never demonstrated. Add a Model Diagnostics section showing it against a fitted Chainladder model. Closes #915.
…python into experimental
henrydingliu
requested review from
genedan,
jbogaardt and
kennethshsu
as code owners
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1020 +/- ##
==========================================
+ Coverage 88.94% 90.08% +1.13%
==========================================
Files 89 89
Lines 5139 5808 +669
Branches 660 899 +239
==========================================
+ Hits 4571 5232 +661
+ Misses 398 397 -1
- Partials 170 179 +9
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
5 participants
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 of Changes
small fixes to developmetnconstant, glm, and model_diagnostics
Related GitHub Issue(s)
Additional Context for Reviewers
uv run pytest) and documentation changes (uv run jb build docs --builder=custom --custom-builder=doctest)Note
Low Risk
Text and documentation only; no changes to algorithms, APIs, or runtime behavior.
Overview
Documentation-only cleanup across development estimators,
model_diagnostics, and the utilities notebook—no behavioral changes.Docstrings:
DevelopmentConstant.fitgets blank lines so NumPy/Sphinx sections parse cleanly.TweedieGLM'spowerparameter replaces the inline ASCII table with a Sphinx.. list-table::for the power→distribution mapping.model_diagnosticssplits a long Returns paragraph so the cross-join /Measurewording renders on separate lines.User guide (
utilities.ipynb): The sample-datasets section drops the hand-maintained table in favor oflist_samples()plus a runnable example. A new Model Diagnostics section documentsmodel_diagnostics()with aChainladder+raaexample. Persistence copy is lightly normalized (backticks).Reviewed by Cursor Bugbot for commit eeb467d. Bugbot is set up for automated code reviews on this repo. Configure here.