Fix read_geotiff_gpu/read_vrt docstring gaps and stale read_geotiff refs (#1637)#1638
Merged
brendancol merged 1 commit intoMay 12, 2026
Merged
Conversation
) read_geotiff_gpu and read_vrt accepted dtype/max_pixels in their signatures but omitted them from the Parameters docstring block. Sibling read functions (open_geotiff, read_geotiff_dask) document both. Adds the missing entries. Also fixes two stale references to the long-removed read_geotiff function: a comment in read_geotiff_dask that should say open_geotiff, and an import in bench_reproject_vs_rioxarray.py.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes docstring/signature drift and stale references in the GeoTIFF/VRT reader surface, improving API discoverability without changing behavior.
Changes:
- Document
dtypeinread_geotiff_gpuandmax_pixelsinread_vrtto match existing signatures. - Update a stale internal comment referencing the removed
read_geotiffsymbol. - Fix a benchmark script import to use
open_geotiffinstead of the removedread_geotiff.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
xrspatial/geotiff/__init__.py |
Docstring parameter coverage fixes (dtype, max_pixels) and update stale comment reference to open_geotiff. |
xrspatial/tests/bench_reproject_vs_rioxarray.py |
Replace stale read_geotiff import/call with open_geotiff to match current public API. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
Closes #1637. Three doc/comment fixes and one stale import. No signature
or behavior change.
read_geotiff_gpu: add the missingdtypeentry to the Parametersblock. The signature already accepted it; sibling read functions
(
open_geotiff,read_geotiff_dask,read_vrt) all documented it.read_vrt: add the missingmax_pixelsentry to the Parametersblock. Signature already accepted it; the three sibling read
functions all documented it.
read_geotiff_dask: fix the staleread_geotiffreference in acomment to say
open_geotiff(the function it refers to).xrspatial/tests/bench_reproject_vs_rioxarray.py: switch the stalefrom xrspatial.geotiff import read_geotiffimport toopen_geotiff.Not in CI; the script never ran since the rename.
Found by
/sweep-api-consistencyCat 3 (docstring/signature drift).Test plan
public read functions document every signature param.
to_geotiff->open_geotiffround-trip withdtype=andmax_pixels=kwargs.