Issue 123 (#125)

* fix docstrings * fix docs and notebooks
DOI-USGS · Nov 28, 2023 · 185ebe4 · 185ebe4
1 parent 741c727
commit 185ebe4
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 8 deletions.
diff --git a/dataretrieval/nwis.py b/dataretrieval/nwis.py
@@ -472,7 +472,7 @@ def get_stats(
     Queries water services statistics information.
 
     For more information about the water services statistics service, visit
-    https://waterservices.usgs.gov/rest/Statistics-Service.html
+    https://waterservices.usgs.gov/docs/statistics/statistics-details/
 
     Parameters
     ----------
@@ -577,7 +577,7 @@ def query_waterservices(
     """
     Queries waterservices.usgs.gov
 
-    For more documentation see https://waterservices.usgs.gov/rest/
+    For more documentation see https://waterservices.usgs.gov/docs/
 
     .. note::
 
@@ -718,7 +718,7 @@ def get_info(ssl_check: bool = True, **kwargs) -> Tuple[pd.DataFrame, BaseMetada
     **Note:** *Must specify one major parameter.*
 
     For additional parameter options see
-    https://waterservices.usgs.gov/rest/Site-Service.html#stateCd
+    https://waterservices.usgs.gov/docs/site-service/site-service-details/
 
     Parameters
     ----------

diff --git a/demos/hydroshare/USGS_dataretrieval_SiteInfo_Examples.ipynb b/demos/hydroshare/USGS_dataretrieval_SiteInfo_Examples.ipynb
@@ -98,7 +98,7 @@
     "* **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",
     "* **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",
     "\n",
-    "For additional parameter options see https://waterservices.usgs.gov/rest/Site-Service.html#stateCd"
+    "For additional parameter options see https://waterservices.usgs.gov/docs/site-service/site-service-details/
    ]
   },
   {

diff --git a/demos/hydroshare/USGS_dataretrieval_SiteInventory_Examples.ipynb b/demos/hydroshare/USGS_dataretrieval_SiteInventory_Examples.ipynb
@@ -96,7 +96,7 @@
     "* **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",
     "* **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",
     "\n",
-    "For additional parameter options see https://waterservices.usgs.gov/rest/Site-Service.html#stateCd"
+    "For additional parameter options see https://waterservices.usgs.gov/docs/site-service/site-service-details/
    ]
   },
   {

diff --git a/docs/source/examples/siteinfo_examples.rst b/docs/source/examples/siteinfo_examples.rst
@@ -11,7 +11,7 @@ example illustrates the use of the ``seriesCatalogOutput`` switch and displays
 the resulting column names for the output dataframes (example prompted by
 `GitHub Issue #34`_).
 
-.. _NWIS water services documentation: https://nwis.waterservices.usgs.gov/rest/Site-Service.html
+.. _NWIS water services documentation: https://waterservices.usgs.gov/docs/site-service/site-service-details/
 
 .. _GitHub Issue #34: https://github.com/DOI-USGS/dataretrieval-python/issues/34
 

diff --git a/tests/data/nwis_sites.txt b/tests/data/nwis_sites.txt
@@ -8,7 +8,7 @@
 # for sites in USA.
 #
 # File-format description:  http://help.waterdata.usgs.gov/faq/about-tab-delimited-output
-# Automated-retrieval info: http://waterservices.usgs.gov/rest/Site-Service.html
+# Automated-retrieval info: https://waterservices.usgs.gov/docs/site-service/site-service-details/
 #
 # Contact:   gs-w_support_nwisweb@usgs.gov
 # Warning: A site search criterion has been used for which the data may be unavailable.

diff --git a/tests/data/waterservices_site.txt b/tests/data/waterservices_site.txt
@@ -8,7 +8,7 @@
 # for sites in USA.
 #
 # File-format description:  http://help.waterdata.usgs.gov/faq/about-tab-delimited-output
-# Automated-retrieval info: http://waterservices.usgs.gov/rest/Site-Service.html
+# Automated-retrieval info: https://waterservices.usgs.gov/docs/site-service/site-service-details/
 #
 # Contact:   gs-w_support_nwisweb@usgs.gov
 #