Fix incorrect docstring parameter names#8344
Open
eeshsaxena wants to merge 1 commit into
Open
Conversation
- tuning.scaling.fixed_hessian documented a 'vars' parameter it does not take (copied from find_hessian); remove the stale entry. - QuadPotentialFullAdapt.__init__ documented its parameter as 'A' but the parameter is named 'cov'.
Documentation build overview
160 files changed ·
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8344 +/- ##
=======================================
Coverage 91.76% 91.76%
=======================================
Files 128 128
Lines 20653 20653
=======================================
Hits 18952 18952
Misses 1701 1701
🚀 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
1 participant
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.
Description
Two docstrings document parameters that do not match their signatures:
pymc.tuning.scaling.fixed_hessian(point, model=None)documents avarsparameter that it does not take (it appears to have been copied fromfind_hessian). The stale entry is removed.QuadPotential.__init__(self, cov, ...)instep_methods/hmc/quadpotential.pydocuments its first parameter asA, but the parameter is namedcov(the body usescov).Documentation-only change; no behaviour is affected.