fix: correct parameter names in docstrings (prob_infl, bin_edges, pred_kwds, param_nums, mu1_low) - #9886
Merged
Conversation
- count_model.py: prob_inlf -> prob_infl in ZeroInflated*._predict_var (x3) - diagnostic.py: binedges -> bin_edges in test_chisquare_prob - _prediction_inference.py: pred_kwargs -> pred_kwds (x3) - aft_el.py: param_num -> param_nums in AftResults.test_beta - originregress.py: param_num -> param_nums in OriginResults.test_beta - descriptive.py: m1_low/m1_upp -> mu1_low/mu1_upp in mv_mean_contour
Aniketsy
approved these changes
Jul 3, 2026
Aniketsy
left a comment
Aniketsy
left a comment
Contributor
There was a problem hiding this comment.
@eeshsaxena thanks for the changes, looks good 👍
Member
|
Thanks. |
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
3 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
Several docstring parameter names do not match the actual function signatures, causing confusion for users reading the API docs.
Fixes
statsmodels/discrete/count_model.pyprob_inlfprob_inflZeroInflated*._predict_vardocstring (3×)statsmodels/discrete/diagnostic.pybinedgesbin_edgestest_chisquare_probdocstringstatsmodels/base/_prediction_inference.pypred_kwargspred_kwdsget_prediction_linear/monotonic/deltadocstrings (3×)statsmodels/emplike/aft_el.pyparam_numparam_numsAftResults.test_betadocstringstatsmodels/emplike/originregress.pyparam_numparam_numsOriginResults.test_betadocstringstatsmodels/emplike/descriptive.pym1_low,m1_uppmu1_low,mu1_uppmv_mean_contourdocstringNo logic changes - docstrings only.