Skip to content

Commit 185ebe4

Browse files
authored
Issue 123 (#125)
* fix docstrings * fix docs and notebooks
1 parent 741c727 commit 185ebe4

6 files changed

Lines changed: 8 additions & 8 deletions

File tree

dataretrieval/nwis.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -472,7 +472,7 @@ def get_stats(
472472
Queries water services statistics information.
473473
474474
For more information about the water services statistics service, visit
475-
https://waterservices.usgs.gov/rest/Statistics-Service.html
475+
https://waterservices.usgs.gov/docs/statistics/statistics-details/
476476
477477
Parameters
478478
----------
@@ -577,7 +577,7 @@ def query_waterservices(
577577
"""
578578
Queries waterservices.usgs.gov
579579
580-
For more documentation see https://waterservices.usgs.gov/rest/
580+
For more documentation see https://waterservices.usgs.gov/docs/
581581
582582
.. note::
583583
@@ -718,7 +718,7 @@ def get_info(ssl_check: bool = True, **kwargs) -> Tuple[pd.DataFrame, BaseMetada
718718
**Note:** *Must specify one major parameter.*
719719
720720
For additional parameter options see
721-
https://waterservices.usgs.gov/rest/Site-Service.html#stateCd
721+
https://waterservices.usgs.gov/docs/site-service/site-service-details/
722722
723723
Parameters
724724
----------

demos/hydroshare/USGS_dataretrieval_SiteInfo_Examples.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
"* **siteOutput** (string 'basic' or 'expanded'): Indicates the richness of metadata you want for site attributes. Note that for visually oriented formats like Google Map format, this argument has no meaning. Note: for performance reasons, siteOutput='expanded' cannot be used if seriesCatalogOutput=true or with any values for outputDataTypeCd.\n",
9999
"* **seriesCatalogOutput** (boolean): A switch that provides detailed period of record information for certain output formats. The period of record indicates date ranges for a certain kind of information about a site, for example the start and end dates for a site's daily mean streamflow.\n",
100100
"\n",
101-
"For additional parameter options see https://waterservices.usgs.gov/rest/Site-Service.html#stateCd"
101+
"For additional parameter options see https://waterservices.usgs.gov/docs/site-service/site-service-details/
102102
]
103103
},
104104
{

demos/hydroshare/USGS_dataretrieval_SiteInventory_Examples.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@
9696
"* **siteOutput** (string 'basic' or 'expanded'): Indicates the richness of metadata you want for site attributes. Note that for visually oriented formats like Google Map format, this argument has no meaning. Note: for performance reasons, siteOutput='expanded' cannot be used if seriesCatalogOutput=true or with any values for outputDataTypeCd.\n",
9797
"* **seriesCatalogOutput** (boolean): A switch that provides detailed period of record information for certain output formats. The period of record indicates date ranges for a certain kind of information about a site, for example the start and end dates for a site's daily mean streamflow.\n",
9898
"\n",
99-
"For additional parameter options see https://waterservices.usgs.gov/rest/Site-Service.html#stateCd"
99+
"For additional parameter options see https://waterservices.usgs.gov/docs/site-service/site-service-details/
100100
]
101101
},
102102
{

docs/source/examples/siteinfo_examples.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ example illustrates the use of the ``seriesCatalogOutput`` switch and displays
1111
the resulting column names for the output dataframes (example prompted by
1212
`GitHub Issue #34`_).
1313

14-
.. _NWIS water services documentation: https://nwis.waterservices.usgs.gov/rest/Site-Service.html
14+
.. _NWIS water services documentation: https://waterservices.usgs.gov/docs/site-service/site-service-details/
1515

1616
.. _GitHub Issue #34: https://github.com/DOI-USGS/dataretrieval-python/issues/34
1717

tests/data/nwis_sites.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
# for sites in USA.
99
#
1010
# File-format description: http://help.waterdata.usgs.gov/faq/about-tab-delimited-output
11-
# Automated-retrieval info: http://waterservices.usgs.gov/rest/Site-Service.html
11+
# Automated-retrieval info: https://waterservices.usgs.gov/docs/site-service/site-service-details/
1212
#
1313
# Contact: gs-w_support_nwisweb@usgs.gov
1414
# Warning: A site search criterion has been used for which the data may be unavailable.

tests/data/waterservices_site.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
# for sites in USA.
99
#
1010
# File-format description: http://help.waterdata.usgs.gov/faq/about-tab-delimited-output
11-
# Automated-retrieval info: http://waterservices.usgs.gov/rest/Site-Service.html
11+
# Automated-retrieval info: https://waterservices.usgs.gov/docs/site-service/site-service-details/
1212
#
1313
# Contact: gs-w_support_nwisweb@usgs.gov
1414
#

0 commit comments

Comments
 (0)