fire: add Examples sections and backend-support notes to docstrings#3512
Merged
brendancol merged 2 commits intoJun 26, 2026
Merged
Conversation
All seven public functions (dnbr, rdnbr, burn_severity_class, fireline_intensity, flame_length, rate_of_spread, kbdi) gained a runnable numpy Examples block and a line stating they support all four backends (numpy, cupy, dask+numpy, dask+cupy). Documentation only; no behavior change. Also records the fire row in the documentation sweep state CSV.
Contributor
Author
PR Review: fire docstrings (Examples + backend notes)Doc-only PR. Reviewed on the head branch with the examples re-executed and the backend claims checked against the dispatch table. BlockersNone. Suggestions
Nits
Out of scope (pre-existing, not changing here)
What looks good
|
Address PR review: the Examples imported via the module path (from xrspatial.fire import X); switch to the public top-level export (from xrspatial import X) so the copy-paste path matches the public API and the rest of the docs. Outputs unchanged and still verified.
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
Documentation-only change to
xrspatial/fire.py. All seven public functions (dnbr,rdnbr,burn_severity_class,fireline_intensity,flame_length,rate_of_spread,kbdi) get:ArrayTypeFunctionMappingdispatch in the module.Why
A documentation audit found that none of the seven functions had an Examples section, and none documented backend support. Other modules (curvature, proximity, multispectral) carry both. This brings fire in line.
Testing
xrspatial/tests/test_fire.py: 73 passedflake8 xrspatial/fire.py: cleanNo behavior changes. Found by the documentation deep-sweep.