Skip to content

Commit 527963d

Browse files
thodson-usgsclaude
andcommitted
docs(nldi): skip get_features_by_data_source example in the doctest build
The example downloads every feature for data_source="nwissite" (all NWIS sites nationwide) — an effectively unbounded slow stream that evades httpx's per-read timeout and hangs `make doctest` (it surfaced as the httpx.ReadTimeout doctest failure). Tag it `# doctest: +SKIP` so it stays a real, rendered doctest example but is not executed, and fix the comment that referenced an unused feature_id. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent df90403 commit 527963d

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

dataretrieval/nldi.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -296,8 +296,9 @@ def get_features_by_data_source(data_source: str) -> gpd.GeoDataFrame:
296296
--------
297297
.. doctest::
298298
299-
>>> # Get features for a feature wqp and feature_id USGS-01031500
300-
>>> gdf = dataretrieval.nldi.get_features_by_data_source(
299+
>>> # "nwissite" returns every NWIS site nationwide, so this example is
300+
>>> # skipped in the doctest build to avoid the (very large) download.
301+
>>> gdf = dataretrieval.nldi.get_features_by_data_source( # doctest: +SKIP
301302
... data_source="nwissite"
302303
... )
303304
"""

0 commit comments

Comments
 (0)