Repository navigation
docs: fix current API keywords in usage examples - #524
Open
dajiaohuang wants to merge 1 commit into
Open
dajiaohuang wants to merge 1 commit into
dajiaohuang wants to merge 1 commit into
Conversation
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.
Package version (main branch)
1.2.1
Description
Correct documentation examples that currently raise
TypeErrorbecause their keyword arguments no longer match the public APIs:ordinary_kriging(..., unknown_location=...)→unknown_locations=...; index the single returned row before describing its fields.unknown_locations=...→unknown_location=....ps_blocks=BLOCKS→blocks=BLOCKSin the constructor examples across the API docstrings.pyproject.toml, rather than nonexistentSETUP.md/setup.cfg, and correcttesttotests.No runtime behavior, signatures, models, dependencies, or license terms change.
Problem
Copying the current examples fails before interpolation/point-support construction. The README also shows a flat result although ordinary kriging returns one row per location.
Validation
pytest -q tests/test_idw/test_idw.py tests/test_core/test_points_data_models.py— 17 passed, one existing GeoPandas FutureWarning.git diff --checkpasses.Package check
The synthetic checks validate these API examples, not the scientific accuracy of every interpolation method or a cross-platform test matrix.