From ef4f1b9d90a56c91e348227082356a98e45f3356 Mon Sep 17 00:00:00 2001 From: Rob Labs Date: Wed, 30 Apr 2025 04:12:13 -0700 Subject: [PATCH] Update docs for `rio-pmtiles` (#564) * `rio-pmtiles` docs: update defaults from code for tile size, format & resampling. Src: `rio_pmtiles/scripts/cli.py`. Tested with v1.0.0 + local GeoTIFF * fix Bug in `rio-pmtiles` docs: `--name` flag did not work. Changed to what source code (cli.py) accepts * Updating the docs for the flag `--description` to match the help note from `cli.py` Line 122 --- python/rio-pmtiles/README.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/python/rio-pmtiles/README.rst b/python/rio-pmtiles/README.rst index bc2fd85..7b7efdc 100644 --- a/python/rio-pmtiles/README.rst +++ b/python/rio-pmtiles/README.rst @@ -45,13 +45,13 @@ Usage -o, --output PATH Path to output file (optional alternative to a positional arg). - --title TEXT PMTiles dataset title. - --description TEXT PMTiles dataset description. + --name TEXT PMTiles metadata name. + --description TEXT PMTiles metadata description. --overlay Export as an overlay (the default). --baselayer Export as a base layer. - -f, --format [JPEG|PNG|WEBP] Tile image format. + -f, --format [JPEG|PNG|WEBP] Tile image format. [default: WEBP] --tile-size INTEGER Width and height of individual square tiles - to create. [default: 256] + to create. [default: 512] --zoom-levels MIN..MAX A min...max range of export zoom levels. The default zoom level is the one at which the @@ -64,7 +64,7 @@ Usage --dst-nodata FLOAT Manually override destination nodata --resampling [nearest|bilinear|cubic|cubic_spline|lanczos|average|mode|gauss|max|min|med|q1|q3|rms] Resampling method to use. [default: - nearest] + bilinear] --version Show the version and exit. --rgba Select RGBA output. For PNG or WEBP only.