Correct some function doc strings, add cache path to error message

src/nemosis/data_fetch_methods.py

@@ -56,14 +56,15 @@ def dynamic_data_compiler(
         parse_data_types (bool): infers data types of columns when reading
                                  data. default True for API use.
         rebuild (bool): If True then cache files are rebuilt
+                        (redownload, re-unzip, re-convert)
                         even if they exist already. False by default.
         **kwargs: additional arguments passed to the pd.to_{fformat}() function
 
     Returns:
         all_data (pd.Dataframe): All data concatenated.
     """
     if not _os.path.isdir(raw_data_location):
-        raise UserInputError("The raw_data_location provided does not exist.")
+        raise UserInputError(f"The raw_data_location {raw_data_location} provided does not exist.")
 
     if table_name not in _defaults.dynamic_tables:
         raise UserInputError("Table name provided is not a dynamic table.")
@@ -177,6 +178,7 @@ def cache_compiler(
                           as object type (compatbile with GUI use). For
                           type inference for a cache, use cache_compiler.
         rebuild (bool): If True then cache files are rebuilt
+                        (redownload, re-unzip, re-convert)
                         even if they exist already. False by default.
         keep_csv (bool): If True raw CSVs from AEMO are not deleted after
                          the cache is built. False by default
@@ -186,7 +188,7 @@ def cache_compiler(
         Nothing
     """
     if not _os.path.isdir(raw_data_location):
-        raise UserInputError("The raw_data_location provided does not exist.")
+        raise UserInputError(f"The raw_data_location {raw_data_location} provided does not exist.")
 
     if table_name not in _defaults.dynamic_tables:
         raise UserInputError("Table name provided is not a dynamic table.")
@@ -262,7 +264,7 @@ def static_table(
         data (pd.Dataframe)
     """
     if not _os.path.isdir(raw_data_location):
-        raise UserInputError("The raw_data_location provided does not exist.")
+        raise UserInputError(f"The raw_data_location {raw_data_location} provided does not exist.")
 
     if table_name not in _defaults.static_tables:
         raise UserInputError("Table name provided is not a static table.")
@@ -434,8 +436,8 @@ def _finalise_csv_data(data, table_name):
 static_downloader_map = {
     "VARIABLES_FCAS_4_SECOND": _downloader.download_csv,
     "ELEMENTS_FCAS_4_SECOND": _downloader.download_elements_file,
-    "Generators and Scheduled Loads": _downloader.download_xl,
-    "_downloader.download_xl": _downloader.download_xl,
+    "Generators and Scheduled Loads": _downloader.download_xml,
+    "_downloader.download_xml": _downloader.download_xml,
 }
 
 static_file_reader_map = {
@@ -543,6 +545,8 @@ def _dynamic_data_fetch_loop(
     1. If it does, read the data in and write any required files
        (parquet or feather).
     2. If it does not, download data then do the same as 1.
+
+    Returns: None if caching_mode=False, else List[pd.Dataframe]
     """
     data_tables = []
 
@@ -719,7 +723,7 @@ def _determine_columns_and_read_csv(
     - To preserve compatability with previous versions of NEMOSIS and
       thus any existing data caches, read in all columns as strings.
 
-    Returns: data, columns
+    Returns: data
     """
     if dtypes == "all":
         type = None
@@ -751,7 +755,7 @@ def _determine_columns_and_read_csv(
 def _write_to_format(data, fformat, full_filename, write_kwargs):
     """
     Used by read_data_and_create_file
-    Writes the DataFrame to a non-CSV format is a non_CSV format is specified.
+    Writes the DataFrame to a non-CSV format if a non_CSV format is specified.
     """
     write_function = {"feather": data.to_feather, "parquet": data.to_parquet}
     # Remove files of the same name - deals with case of corrupted files.

src/nemosis/defaults.py

@@ -132,7 +132,7 @@
     "ELEMENTS_FCAS_4_SECOND": "https://www.nemweb.com.au/Reports/Current/Causer_Pays_Elements/",
     "VARIABLES_FCAS_4_SECOND": "https://aemo.com.au/-/media/files/electricity/nem/settlements_and_payments/settlements/auction-reports/archive/ancillary-services-market-causer-pays-variables-file.csv",
     "Generators and Scheduled Loads": "https://www.aemo.com.au/-/media/Files/Electricity/NEM/Participant_Information/NEM-Registration-and-Exemption-List.xls",
-    "_downloader.download_xl": "https://www.aemo.com.au/-/media/Files/Electricity/NEM/Participant_Information/NEM-Registration-and-Exemption-List.xls",
+    "_downloader.download_xml": "https://www.aemo.com.au/-/media/Files/Electricity/NEM/Participant_Information/NEM-Registration-and-Exemption-List.xls",
 }
 
 aemo_mms_url = "http://www.nemweb.com.au/Data_Archive/Wholesale_Electricity/MMSDM/{}/MMSDM_{}_{}/MMSDM_Historical_Data_SQLLoader/DATA/{}.zip"

src/nemosis/downloader.py

@@ -260,8 +260,8 @@ def download_unzip_csv(url, down_load_to):
 
 def download_csv(url, path_and_name):
     """
-    This function downloads a zipped csv using a url,
-    extracts the csv and saves it a specified location
+    This function downloads a csv using a url,
+    and saves it a specified location
     """
     r = requests.get(url, headers=USR_AGENT_HEADER)
     with open(path_and_name, "wb") as f:
@@ -280,9 +280,9 @@ def download_elements_file(url, path_and_name):
         f.write(r.content)
 
 
-def download_xl(url, path_and_name):
+def download_xml(url, path_and_name):
     """
-    This function downloads a zipped csv using a url, extracts the csv and
+    This function downloads a XML using a url, and
     saves it a specified location
     """
     r = requests.get(url, headers=USR_AGENT_HEADER)