Document bigtiff kwarg in to_geotiff docstring (#1683)#1686
Merged
brendancol merged 2 commits intoMay 12, 2026
Merged
Conversation
The Parameters block jumped from overview_resampling to gpu, omitting the bigtiff entry that has been on the signature for several releases. write_geotiff_gpu documents the same kwarg, so callers who learned the API from the GPU writer and ported a call to to_geotiff had no way to discover the option from help(to_geotiff). Pin the entry against future drift with a test that walks the Parameters block and compares it to inspect.signature().
Three MEDIUM findings filed and fixed: xarray-contrib#1683 (bigtiff docstring gap on to_geotiff), xarray-contrib#1684 (write_vrt nodata float|None widened to float|int|None), and xarray-contrib#1685 (open_geotiff silently dropped overview_level / on_gpu_failure on VRT sources). PRs xarray-contrib#1686, xarray-contrib#1687, and xarray-contrib#1689. cuda-validated.
brendancol
added a commit
to brendancol/xarray-spatial
that referenced
this pull request
May 12, 2026
Three MEDIUM findings filed and fixed: xarray-contrib#1683 (bigtiff docstring gap on to_geotiff), xarray-contrib#1684 (write_vrt nodata float|None widened to float|int|None), and xarray-contrib#1685 (open_geotiff silently dropped overview_level / on_gpu_failure on VRT sources). PRs xarray-contrib#1686, xarray-contrib#1687, and xarray-contrib#1689. cuda-validated.
brendancol
added a commit
to brendancol/xarray-spatial
that referenced
this pull request
May 12, 2026
Three MEDIUM findings filed and fixed: xarray-contrib#1683 (bigtiff docstring gap on to_geotiff), xarray-contrib#1684 (write_vrt nodata float|None widened to float|int|None), and xarray-contrib#1685 (open_geotiff silently dropped overview_level / on_gpu_failure on VRT sources). PRs xarray-contrib#1686, xarray-contrib#1687, and xarray-contrib#1689. cuda-validated.
brendancol
added a commit
that referenced
this pull request
May 12, 2026
* Widen write_vrt nodata type hint to accept int (#1684) write_vrt advertised `nodata: float | None` while the sibling writers to_geotiff and write_geotiff_gpu accept "float, int, or None" with no type annotation. Integer sentinels (65535 for uint16, -9999 for int32) round-trip through the rest of the I/O surface; the float-only hint was a static-typing trap, not a runtime constraint. Widen to `float | int | None` on the public wrapper and the internal _vrt.write_vrt, and document the surface match in both docstrings. Add a round-trip regression so future drift surfaces. * Update api-consistency sweep state for geotiff v2 (2026-05-12) Three MEDIUM findings filed and fixed: #1683 (bigtiff docstring gap on to_geotiff), #1684 (write_vrt nodata float|None widened to float|int|None), and #1685 (open_geotiff silently dropped overview_level / on_gpu_failure on VRT sources). PRs #1686, #1687, and #1689. cuda-validated.
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.
Summary
to_geotiffaccepts abigtiffkwarg, but the Parameters block of the docstring skipped fromoverview_resamplingdirectly togpu.write_geotiff_gpudocuments the same kwarg already, so the omission only affected the CPU dispatcher's docstring.overview_resamplingandgpu, using the same wording the GPU writer uses, and pin both writers against future drift with a test that walks the docstring's Parameters block.Fixes #1683. Found during the geotiff API consistency sweep (Cat 3, MEDIUM).
Test plan
pytest xrspatial/geotiff/tests/test_to_geotiff_bigtiff_doc_1683.pybigtiffis documented forto_geotiffto_geotiffis documentedwrite_geotiff_gpukeeps full coverage too