DOC fix kwargs parameter name in curvefit docstrings - #11536
Open
advitrocks9 wants to merge 2 commits into
Open
Conversation
Both methods take a collecting `kwargs: dict[str, Any] | None = None`, not `**kwargs`, so calling them the way the docstring describes raises TypeError. `xarray/computation/fit.py`, which both delegate to, already spells it correctly.
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.
Description
Fixes #6891.
Dataset.curvefitandDataArray.curvefitboth document their scipy passthrough as**kwargs : optional, so calling them the way the docstring describes fails:Same on
Dataset. Neither method actually has aVAR_KEYWORDparameter, they take a singlekwargs: dict[str, Any] | None = None, andkwargs={"method": "trf"}works fine. So the docstrings are wrong, not the behaviour.computation/fit.py,which both methods delegate to, already documents the parameter correctly, the class docstrings
just drifted from it in #5182. headtr1ck
scoped this fix on the issue:
change
**kwargstokwargsin both docstrings.Checklist
curvefitthrows an exception. #6891whats-new.rstapi.rst