Summary
xrspatial.geotiff.to_geotiff accepts a bigtiff keyword argument (see signature at xrspatial/geotiff/__init__.py:986), but the Parameters block of its docstring jumps from overview_resampling directly to gpu, omitting the bigtiff entry. Users browsing help(to_geotiff) cannot tell that the kwarg exists or what its accepted values are.
The sibling write_geotiff_gpu docstring at xrspatial/geotiff/__init__.py:2925 does document the same parameter:
bigtiff : bool or None
Force BigTIFF (64-bit offsets). None auto-promotes when the
estimated file size would exceed the classic-TIFF 4 GB limit.
The underlying writer signature for bigtiff is identical in the two entry points; this is purely a docstring omission.
Proposed fix
Add the bigtiff parameter description to to_geotiff's Parameters block between overview_resampling and gpu, using the same wording as write_geotiff_gpu.
Found during the geotiff API consistency sweep (Cat 3, MEDIUM).
Summary
xrspatial.geotiff.to_geotiffaccepts abigtiffkeyword argument (see signature atxrspatial/geotiff/__init__.py:986), but the Parameters block of its docstring jumps fromoverview_resamplingdirectly togpu, omitting thebigtiffentry. Users browsinghelp(to_geotiff)cannot tell that the kwarg exists or what its accepted values are.The sibling
write_geotiff_gpudocstring atxrspatial/geotiff/__init__.py:2925does document the same parameter:The underlying writer signature for
bigtiffis identical in the two entry points; this is purely a docstring omission.Proposed fix
Add the
bigtiffparameter description toto_geotiff's Parameters block betweenoverview_resamplingandgpu, using the same wording aswrite_geotiff_gpu.Found during the geotiff API consistency sweep (Cat 3, MEDIUM).