diff --git a/.claude/sweep-documentation-state.csv b/.claude/sweep-documentation-state.csv index 818225d59..5a7de5e2b 100644 --- a/.claude/sweep-documentation-state.csv +++ b/.claude/sweep-documentation-state.csv @@ -1,3 +1,4 @@ module,last_inspected,issue,severity_max,categories_found,notes,doc_coverage +geotiff,2026-06-25,,MEDIUM,1,"to_geotiff (public write entry point) had Parameters/Returns/Raises but no Examples section while open_geotiff does (Cat1 MEDIUM); added Examples block (plain GeoTIFF, cog=True, .vrt mosaic) modeled on open_geotiff; fixed on deep-sweep-documentation-geotiff-2026-06-25; repo issues disabled so no issue number. Cat2/3/4/5 clean: open_geotiff/to_geotiff signature-docstring parity locked by parity/test_signature_contract.py + write/test_bigtiff.py + test_polish.py; both funcs in autosummary in reference/geotiff.rst; reference page mirrors SUPPORTED_FEATURES tiers (tier-parity gate); CUDA available, all docstring examples are +SKIP illustrative only",2/2 fire,2026-06-25,,MEDIUM,1;5,"all 7 public funcs (dnbr, rdnbr, burn_severity_class, fireline_intensity, flame_length, rate_of_spread, kbdi) lacked Examples section (Cat1 MEDIUM) and backend-support note (Cat5 MEDIUM); fixed in deep-sweep-documentation-fire-2026-06-25-01; repo issues disabled so no issue number; examples run and outputs match numpy backend; all 7 listed in reference/fire.rst; no Cat2/Cat3/Cat4 issues",7/7 perlin,2026-06-23,,MEDIUM,2;5,"name param undocumented (Cat2) + float-dtype requirement/ValueError undocumented, no Raises section (Cat5); fixed in deep-sweep-documentation-perlin-2026-06-23; repo has issues disabled so no issue number; example runs and output matches; 1 public func (perlin) listed in reference/surface.rst",1/1 diff --git a/xrspatial/geotiff/_writers/eager.py b/xrspatial/geotiff/_writers/eager.py index a2129d412..dfa148cbe 100644 --- a/xrspatial/geotiff/_writers/eager.py +++ b/xrspatial/geotiff/_writers/eager.py @@ -457,6 +457,23 @@ def to_geotiff(data: xr.DataArray | np.ndarray, ``col``). A leading non-band dim such as ``time`` is rejected because the writer cannot infer the band axis from arbitrary names and used to silently treat the leading axis as ``y``. + + Examples + -------- + Write a DataArray to a plain GeoTIFF and read it back: + + >>> from xrspatial.geotiff import open_geotiff, to_geotiff + >>> to_geotiff(data, 'elevation.tif') # doctest: +SKIP + >>> da = open_geotiff('elevation.tif') # doctest: +SKIP + + Write a Cloud Optimized GeoTIFF (tiled, with internal overviews): + + >>> to_geotiff(data, 'elevation_cog.tif', cog=True) # doctest: +SKIP + + Write a VRT mosaic. A ``.vrt`` output path tiles the array and emits + the index that references the tiles: + + >>> to_geotiff(data, 'mosaic.vrt') # doctest: +SKIP """ from .._reader import _coerce_path