docs(mahalanobis): add Examples and document NaN propagation#3581
Merged
brendancol merged 1 commit intoJul 1, 2026
Merged
Conversation
The public mahalanobis() docstring had Parameters and Returns but no Examples section, unlike peer utilities such as normalize.rescale. Its NaN-propagation rule was also undocumented despite being pinned by test_nan_propagation. Add a runnable Examples block (whose input includes a NaN so the output shows propagation directly), a Notes section covering the NaN rule, the auto-stats N+1 all-finite requirement, and the four supported backends, and note default='mahalanobis' on the name parameter. Documentation only; no behavior change. Refs xarray-contrib#3579
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.
Adds the missing pieces to the
mahalanobis()docstring:.. sourcecode:: pythonblock. The example mixes a NaN into one band so the output shows propagation directly.default='mahalanobis'on thenameparameter, matching hownormalize.rescaledocuments itsname.Documentation only. No behavior change. The Returns float64/shape claim and the four-backend claim already match the
ArrayTypeFunctionMappingdispatch, so those were left alone. Existingtest_mahalanobis.pystill passes (24 tests).Closes #3579