docs(bump): correct height_func contract and count default in docstring#3607
Open
brendancol wants to merge 1 commit into
Open
docs(bump): correct height_func contract and count default in docstring#3607brendancol wants to merge 1 commit into
brendancol wants to merge 1 commit into
Conversation
The height_func Parameters entry described a per-point f(x, y) contract, but bump() calls height_func(locations) once with a (count, 2) array of integer (x, y) coordinates and expects a length-count heights array back. The documented per-point form raises TypeError when used literally. Also mark count as optional and document its default of min(width * height // 10, 10_000_000), which was previously unstated. Docstring-only; no behavior change. Records the doc sweep state for bump. Refs xarray-contrib#3606
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.
Fixes two accuracy problems in the
bump()docstring, found during a documentation sweep of the module.height_funcwas described as takingx, yper point.bump()actually calls it once with a(count, 2)locations array and expects a length-countheights array back. The per-point form raisesTypeErrorwhen used literally.countwas typedintwith no default. It is optional and defaults tomin(width * height // 10, 10_000_000).Docstring-only, no behavior change. The runnable example already used the array-based
height_funcconvention, so it needed no edit.Closes #3606