Docs: output verification in examples + document fixed_season (#128)#129
Open
Sammyjoseph999 wants to merge 2 commits into
Open
Docs: output verification in examples + document fixed_season (#128)#129Sammyjoseph999 wants to merge 2 commits into
Sammyjoseph999 wants to merge 2 commits into
Conversation
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.
Addresses the website feedback in #128.
Changes
1–3. Examples now show their output. The quickstart and API "Fetching data" examples ran without any confirmation of what was fetched. Added
df.shape/df.columns/df.head()so users see the returned DataFrame, and switched them to the credential-freenasa_powerpath so they run as-is.2. Seasonal output as a table.
docs/getting_started.md"First analysis" now tabulatesanalyze_climate_statisticsresults (year / rain / NDWS / WRSI) with pandas instead of showing a mixed dict, and drops the Earth-Engineevaluate_hazardscall so the whole section is credential-free.4.
fixed_seasondocumented — and the warning fixed. The reporter noted the "season counts differ" warning tells you to use--fixed-seasonbut there’s "no documented way to pass this parameter." In factfixed_seasonalready exists inanalyze_climate_statistics(it takes a"MM-DD:MM-DD"string, notTrue). So:fixed_season="03-01:05-31"with a note on why/when to use it.climate_statistics/statistics.py) now points tofixed_season="MM-DD:MM-DD"(Python API) in addition to--fixed-season(CLI), so it stops sending Python users to a CLI-only flag.Verification
mkdocs build --strictpasses; ruff clean; full suite 598 passed (the preserved warning-prefix keeps existing assertions green).