You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs+types: reference/build fixups and unify last_modified type (#326)
* docs+types: add NGWMN README section + samples reference page, fix conf root_doc, drop dead nblink media, unify last_modified type
Four small, independent fixups surfaced in a library review:
- docs: add a `reference/samples.rst` page and wire it into the API
reference toctree. `dataretrieval.samples` is public (in `__all__`)
but had no reference page.
- docs(conf): `main_doc` is not a recognized Sphinx setting (the correct
name is `root_doc`); it was silently ignored. Rename so the intent is
real rather than relying on the `index` default.
- docs(examples): drop the `extra-media: ../../../demos/datasets` entry
from `peak_streamflow_trends.nblink`. That directory does not exist and
the notebook reads no local files, so nbsphinx_link warned/failed
copying missing media on every docs build.
- types(waterdata): widen `get_daily`/`get_continuous` `last_modified`
from `str | None` to `str | Iterable[str] | None`, matching the other
eight OGC getters. `last_modified` is routed through `_format_api_dates`,
which accepts a single interval string or a two-element [start, end]
range list, so the narrow annotation rejected a valid input shape and
was inconsistent with the parallel getters.
- README: add an NGWMN usage example (state -> sites -> water levels) and an
NGWMN entry under Available Data Services; reformat that section as a
function index -- each service led by its function name (e.g. `get_dv`)
with a brief description, and each subsection tagged with its module.
- README: document `get_ratings` (usage example + index entry) and note
its `dict`-of-rating-tables return shape; pass a Series to a getter
directly in the NGWMN example (drop the redundant `.tolist()`).
---------
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
0 commit comments