Update docstrings

master
Dan Howe 6 years ago
parent e360496984
commit 74eed20c20

@ -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 ##

@ -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:

Loading…
Cancel
Save