Enhance docstrings and examples for improved clarity for many estimators#747
Open
kennethshsu wants to merge 12 commits intomainfrom
Open
Enhance docstrings and examples for improved clarity for many estimators#747kennethshsu wants to merge 12 commits intomainfrom
kennethshsu wants to merge 12 commits intomainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #747 +/- ##
=======================================
Coverage 85.94% 85.94%
=======================================
Files 85 85
Lines 4924 4924
Branches 637 637
=======================================
Hits 4232 4232
Misses 491 491
Partials 201 201
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:
|
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 of Changes
Related GitHub Issue(s)
#704
Additional Context for Reviewers
None
Note
Low Risk
Changes are limited to documentation/docstrings and contributor workflow guidance; runtime behavior is not modified. Main risk is doctest/example output drift causing docs build failures.
Overview
Improves estimator documentation and doctest examples for
Benktander,BornhuetterFerguson,CapeCod, andExpectedLoss, including clearer parameter guidance (e.g.,n_itersbehavior and apriori vssample_weight) and refreshed sample-based outputs.Documentation plumbing updates: adds
ExpectedLossto the API reference (and generated rst stub), updates contributing guidance and PR template with a checkbox and explicit commands to runpytestand rebuild docs with doctests.Reviewed by Cursor Bugbot for commit 0d15ebc. Bugbot is set up for automated code reviews on this repo. Configure here.