From 74eed20c20ebd88d8fe5573e7bfdb4718e46b8a1 Mon Sep 17 00:00:00 2001 From: Dan Howe Date: Fri, 15 Feb 2019 15:24:23 +1100 Subject: [PATCH] Update docstrings --- README.md | 2 +- waternsw_grabber/waternsw_grabber.py | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2af1e6d..b978939 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # waternsw-grabber # -**waternsw_grabber** downloads bore records from the WaterNSW data portal. +**waternsw_grabber** downloads bore records from the WaterNSW data portal. https://realtimedata.waternsw.com.au ## Installation ## diff --git a/waternsw_grabber/waternsw_grabber.py b/waternsw_grabber/waternsw_grabber.py index d9feec7..2d2388f 100644 --- a/waternsw_grabber/waternsw_grabber.py +++ b/waternsw_grabber/waternsw_grabber.py @@ -58,8 +58,8 @@ def get_telemetered_bore(driver, bore_id, start_date, end_date): Args: driver: selenium webdriver object bore_id: bore ID (string) - start_date: start date (string in ISO-8601 format) - end_date: end date (string in ISO-8601 format) + start_date: start date (string in YYYY-MM-DD format) + end_date: end date (string in YYYY-MM-DD format) """ url = 'https://realtimedata.waternsw.com.au/water.stm' @@ -192,8 +192,8 @@ def telemetered_bore_downloader(bore_ids, start_date, end_date, download_dir): Args: bore_ids: bore ID values (array-like) - start_date: start date (string in ISO-8601 format) - end_date: end date (string in ISO-8601 format) + start_date: start date (string YYYY-MM-DD format) + end_date: end date (string YYYY-MM-DD format) download_dir: path to where downloaded files will be saved Raises: