docs: add tail estimator doctest examples#801
Conversation
EKtheSage
requested review from
genedan,
henrydingliu,
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 #801 +/- ##
=======================================
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:
|
EKtheSage
force-pushed
the
docs/704-tail-examples
branch
from
bf1dd34 to
9df7c01
Compare
|
|
||
| Examples | ||
| -------- | ||
| Start the Bondy fit later when earlier link ratios are too volatile for the |
There was a problem hiding this comment.
this is an instructive example. please elaborate
|
|
||
| .. testoutput:: | ||
|
|
||
| 0.5 |
There was a problem hiding this comment.
are these two results too close to demonstrate the theoretical knowledge offer by the setup of the example?
| -------- | ||
| Compare Clark growth curves when the selected tail shape is part of the | ||
| modeling judgment. The tail LDF changes because each curve extrapolates the | ||
| remaining development differently. |
There was a problem hiding this comment.
these sentences are tautologies (i.e. output changes because input is different), which are not instructive. can we explain why one is much higher than the other, rather than just observing that they are in fact different?
|
|
||
| Examples | ||
| -------- | ||
| Compare parametric tail curves when the same development pattern can |
There was a problem hiding this comment.
when should someone use exponential? when should someone use power? what should they use to evaluate the fit?
2 participants
Summary: Add Sphinx doctest examples for TailBondy, TailClark, and TailCurve docs. Split from the larger #792 work and intentionally excludes .github/workflows/sync-main-to-docs.yml. Refs #704
Note
Low Risk
Low risk documentation-only change; the main risk is brittle doctest expectations if sample data or numeric outputs change.
Overview
Adds Sphinx doctest
Examplessections to theTailBondy,TailClark, andTailCurvedocstrings, showing how changing key parameters (e.g.,earliest_age,growth,curve) affects the fitted tail/LDF outputs.These examples include
testsetup,testcode, and expectedtestoutputblocks so the documentation can be validated as executable examples.Reviewed by Cursor Bugbot for commit 9df7c01. Bugbot is set up for automated code reviews on this repo. Configure here.