Fix nbr() docstring parameter name to match signature (swir2_agg)#3435
Merged
brendancol merged 2 commits intoJun 20, 2026
Merged
Conversation
nbr() documents its second band as swir_agg, but the signature parameter is swir2_agg, so copying the name from the docs raises a TypeError. Rename the docstring entry to swir2_agg. Add test_docstring_params_match_signature over the 17 public index functions to assert the documented parameter set matches the signature. Closes #3433
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.
What
nbr()documents its second band asswir_aggin the docstring, but the signature parameter isswir2_agg. This renames the docstring entry to match.Why
Copy the parameter name straight out of the rendered docs and
nbr(..., swir_agg=...)raises a TypeError. Every other function in the module documents its parameters under the real names, so nbr was the odd one out.Tests
Adds
test_docstring_params_match_signature, parametrized over the 17 public index functions, asserting the documented parameter set equals the signature parameter set. It fails on the pre-fix docstring and passes after the rename. Full multispectral suite (171 tests across numpy, dask, and cupy) passes.Docs-only change, no API impact, no deprecation needed.
Closes #3433
Found by the api-consistency deep-sweep on the multispectral module.