Add Examples section to to_geotiff docstring#3521
Merged
Merged
Conversation
open_geotiff has an Examples section; to_geotiff did not, even though it's the matching write entry point and already documents Parameters, Returns, and Raises. Add a numpydoc Examples block with +SKIP doctest snippets for a plain GeoTIFF write/read, a cog=True write, and a .vrt mosaic write, following the open_geotiff block and the writing examples in docs/source/reference/geotiff.rst. Docs only, no behavior change. Found by the documentation deep-sweep of the geotiff module.
Contributor
Author
PR Review: Add Examples section to to_geotiff docstringReviewed from the head-branch worktree. Docs-only change: an Examples block on the BlockersNone. SuggestionsNone. Nits
What looks good
Checklist
Verdict: no actionable changes. Accurate and consistent with the existing |
# Conflicts: # .claude/sweep-documentation-state.csv
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
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.
What
Adds an Examples section to the
to_geotiffdocstring.Why
open_geotiffhas an Examples section with copy-pasteable usage.to_geotiff, the matching write entry point, documented Parameters, Returns, and Raises but had no Examples. That was the one structural docstring gap a documentation sweep of the geotiff module turned up; everything else (signature/docstring parity, reference-page coverage, tier claims) is already locked by tests.What changed
A numpydoc Examples block with three
>>> ... # doctest: +SKIPsnippets, following theopen_geotiffblock and the writing examples already indocs/source/reference/geotiff.rst:cog=TrueCloud Optimized GeoTIFF write.vrtmosaic writeDocs only. No behavior change, no signature change.
test_polish.pyandtest_to_geotiff_parameters_match_signature_1683pass.