Add caveat and assumption admonitions to docs#1134
Merged
Conversation
New user guide page (caveats.rst) collecting the cross-cutting assumptions: WGS84 hardcoded in geodesic path, float32 output, NaN-as-nodata, pixel-unit proximity, dask chunk requirements, GPU memory, and dimension ordering. Admonition blocks added to existing reference pages: surface, proximity, focal, classification, hydrology, terrain_metrics, and the data_types guide.
…1133) - Proximity EUCLIDEAN returns coordinate-unit distances, not pixels - Great-circle returns metres, not kilometres - Terrain metrics output float64, not float32; drop Horn attribution - Add admonitions to multispectral, zonal, and pathfinding pages - Clarify haversine section title
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.
Closes #1133.
Summary
caveats.rst) documenting cross-cutting assumptions: WGS84 hardcoded in geodesic functions, float32 output casting, NaN-as-nodata semantics, proximity distance units, dask chunk requirements, GPU memory, dimension ordering... danger::,.. warning::,.. caution::,.. tip::,.. note::) added to 9 reference pages (surface, proximity, focal, classification, hydrology, terrain_metrics, multispectral, zonal, pathfinding)... note::indata_types.rstupgraded to.. warning::with.astype()suggestion.Test plan
caveats.rstrenders correctly in Sphinx HTML build:ref:link todata_typesresolves