DOC: updated docstrings

Updated the description of `mock_download_dir` in the docstrings.

pysatSpaceWeather/instruments/methods/ace.py

@@ -177,8 +177,9 @@ def download(date_array, name, tag='', inst_id='', data_path='', now=None,
         Current universal time, if None this is determined for each
         download. (default=None)
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------

pysatSpaceWeather/instruments/methods/general.py

@@ -80,7 +80,9 @@ def get_local_or_remote_text(url, mock_download_dir, filename):
     url : str
         Remote URL where file is located
     mock_download_dir : str or NoneType
-        If not None, directory where file is located
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Returns
     -------

pysatSpaceWeather/instruments/methods/gfz.py

@@ -80,9 +80,9 @@ def json_downloads(date_array, data_path, local_file_prefix, local_date_fmt,
         If true, selects only the definitive data, otherwise also includes
         nowcast data (default=False)
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        (following the local file prefix and date format) as if they were
-        downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date (following the local
+        file prefix and date format) as if they were downloaded (default=None)
 
     Raises
     ------
@@ -188,8 +188,9 @@ def kp_ap_cp_download(platform, name, date_array, tag, inst_id, data_path,
     data_path : str
         Path to data directory.
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date (following the local
+        file prefix and date format) as if they were downloaded (default=None)
 
     Raises
     ------

pysatSpaceWeather/instruments/methods/lasp.py

@@ -22,8 +22,9 @@ def prediction_downloads(name, tag, data_path, mock_download_dir=None):
     data_path : str
         Path to data directory.
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date (following the local
+        file prefix and date format) as if they were downloaded (default=None)
 
     Raises
     ------

pysatSpaceWeather/instruments/methods/lisird.py

@@ -117,8 +117,9 @@ def download(date_array, data_path, local_file_prefix, local_date_fmt,
         Dict of fill values to replace with NaN by variable name or None to
         leave alone (default=None)
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date (following the local
+        file prefix and date format) as if they were downloaded (default=None)
 
     Raises
     ------

pysatSpaceWeather/instruments/methods/swpc.py

@@ -41,8 +41,9 @@ def daily_dsd_download(name, today, data_path, mock_download_dir=None):
     data_path : str
         Path to data directory.
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------
@@ -106,8 +107,9 @@ def old_indices_dsd_download(name, date_array, data_path, local_files, today,
     today : dt.datetime
         Datetime for current day
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------
@@ -394,8 +396,9 @@ def solar_geomag_predictions_download(name, date_array, data_path,
     data_path : str
         Path to data directory.
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------
@@ -570,8 +573,9 @@ def geomag_forecast_download(name, date_array, data_path,
     data_path : str
         Path to data directory.
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------
@@ -697,8 +701,9 @@ def kp_ap_recent_download(name, date_array, data_path, mock_download_dir=None):
     data_path : str
         Path to data directory.
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------
@@ -810,8 +815,9 @@ def recent_ap_f107_download(name, date_array, data_path,
     data_path : str
         Path to data directory.
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------

pysatSpaceWeather/instruments/sw_ae.py

@@ -153,8 +153,9 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None):
     data_path : str
         Path to data directory.
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------

pysatSpaceWeather/instruments/sw_al.py

@@ -153,8 +153,9 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None):
     data_path : str
         Path to data directory.
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------

pysatSpaceWeather/instruments/sw_ap.py

@@ -228,8 +228,9 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None):
     data_path : str
         Path to data directory.
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Note
     ----

pysatSpaceWeather/instruments/sw_apo.py

@@ -182,8 +182,9 @@ def download(date_array, tag, inst_id, data_path, update_files=False,
     update_files : bool
         Re-download data for files that already exist if True (default=False)
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Note
     ----

pysatSpaceWeather/instruments/sw_au.py

@@ -153,8 +153,9 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None):
     data_path : str
         Path to data directory.
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------

pysatSpaceWeather/instruments/sw_dst.py

@@ -254,7 +254,11 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None):
     data_path : str
         Path to data directory.
         If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        as if they were downloaded
+    mock_download_dir : str or NoneType
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------

pysatSpaceWeather/instruments/sw_f107.py

@@ -375,8 +375,9 @@ def download(date_array, tag, inst_id, data_path, update_files=False,
     update_files : bool
         Re-download data for files that already exist if True (default=False)
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------

pysatSpaceWeather/instruments/sw_flare.py

@@ -327,8 +327,9 @@ def download(date_array, tag, inst_id, data_path, update_files=False,
     update_files : bool
         Re-download data for files that already exist if True (default=False)
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------

pysatSpaceWeather/instruments/sw_hpo.py

@@ -181,8 +181,9 @@ def download(date_array, tag, inst_id, data_path, update_files=False,
     update_files : bool
         Re-download data for files that already exist if True (default=False)
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Note
     ----

pysatSpaceWeather/instruments/sw_kp.py

@@ -380,8 +380,9 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None):
     data_path : str
         Path to data directory.
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------

pysatSpaceWeather/instruments/sw_mgii.py

@@ -269,8 +269,9 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None):
     data_path : str
         Path to data directory.
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------

pysatSpaceWeather/instruments/sw_polarcap.py

@@ -166,8 +166,9 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None):
     data_path : str
         Path to data directory.
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------

pysatSpaceWeather/instruments/sw_sbfield.py

@@ -241,8 +241,9 @@ def download(date_array, tag, inst_id, data_path, update_files=False,
     update_files : bool
         Re-download data for files that already exist if True (default=False)
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------

pysatSpaceWeather/instruments/sw_ssn.py

@@ -277,8 +277,9 @@ def download(date_array, tag, inst_id, data_path, update_files=False,
     update_files : bool
         Re-download data for files that already exist if True (default=False)
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------

pysatSpaceWeather/instruments/sw_stormprob.py

@@ -167,8 +167,9 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None):
     data_path : str
         Path to data directory.
     mock_download_dir : str or NoneType
-        If not None, will process any files with the correct name and date
-        as if they were downloaded (default=None)
+        Local directory with downloaded files or None. If not None, will
+        process any files with the correct name and date as if they were
+        downloaded (default=None)
 
     Raises
     ------