Fix incorrect parameter names in docstrings#316
Merged
PaulWAyers merged 2 commits intoJul 2, 2026
Conversation
Three docstrings documented parameter names that don't match their signatures: - NumericalIntegrand.integrate documented 'integrand' but the parameter is 'integrand_function'. - _evaluate_coeffs_on_points documented 'coeffs' but the parameter is 'coeff'. - deriv3 documented 'array' but the parameter is 'x'.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR corrects mismatched parameter names in three NumPy-style docstrings so the documented parameter names match their corresponding function signatures.
Changes:
- Update
NumericalIntegrand.integratedocstring parameter name fromintegrandtointegrand_function. - Update
_evaluate_coeffs_on_pointsdocstring parameter name fromcoeffstocoeff. - Update
deriv3docstring parameter name fromarraytox.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/grid/ngrid.py | Renames the documented integrate parameter to integrand_function (but docstring still has a duplicated/incorrect integration_chunk_size section). |
| src/grid/ode.py | Renames the documented _evaluate_coeffs_on_points parameter to coeff. |
| src/grid/rtransform.py | Renames the documented deriv3 parameter to x. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+179
to
182
| integrand_function : callable | ||
| Integrand function to integrate. It must take a list of arguments (one for each domain) | ||
| with the same dimension as the grid points used for the corresponding domain and return | ||
| a float (e.g. a function of the form f([x1,y1,z1], [x2,y2,z2]) -> float). |
The integrate docstring documented integration_chunk_size twice; the first entry had an incorrect default (1000 vs the signature's 6000) and appeared out of order. Keep the single correct entry.
Contributor
Author
|
Good catch on the duplicate |
marco-2023
approved these changes
Jun 30, 2026
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
Three docstrings documented parameter names that do not match their function signatures:
NumericalIntegrand.integrate(src/grid/ngrid.py) documentedintegrand, but the parameter isintegrand_function._evaluate_coeffs_on_points(src/grid/ode.py) documentedcoeffs, but the parameter iscoeff.deriv3(src/grid/rtransform.py) documentedarray, but the parameter isx.This corrects the documented names to match each signature. Documentation-only change.