DOC: added comments

Added inline and block comments to show filtering motivation.
pysat · Sep 5, 2024 · f3f1e35 · f3f1e35
1 parent bd5980e
commit f3f1e35
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/pysatMadrigal/instruments/madrigal_dst.py b/pysatMadrigal/instruments/madrigal_dst.py
@@ -68,7 +68,7 @@
 madrigal_tag = {'': {'': "30006"}}
 madrigal_start = dt.datetime(1957, 1, 1)
 madrigal_end = pysat.utils.time.filter_datetime_input(
-    dt.datetime.now(tz=dt.timezone.utc))
+    dt.datetime.now(tz=dt.timezone.utc))  # Filters out timezone
 
 # Local attributes
 #

diff --git a/pysatMadrigal/instruments/madrigal_geoind.py b/pysatMadrigal/instruments/madrigal_geoind.py
@@ -68,7 +68,7 @@
 madrigal_tag = {'': {'': "30007"}}
 madrigal_start = dt.datetime(1950, 1, 1)
 madrigal_end = pysat.utils.time.filter_datetime_input(
-    dt.datetime.now(tz=dt.timezone.utc))
+    dt.datetime.now(tz=dt.timezone.utc))  # Filters out timezone
 
 # Local attributes
 #

diff --git a/pysatMadrigal/instruments/methods/general.py b/pysatMadrigal/instruments/methods/general.py
@@ -1104,6 +1104,8 @@ def get_remote_filenames(inst_code=None, kindat='', user=None, password=None,
 
     if stop is None:
         stop = dt.datetime.now(tz=dt.timezone.utc)
+
+    # Ensure the end time does not have timezone information
     stop = pysat.utils.time.filter_datetime_input(stop)
 
     # If start and stop are identical, increment