Improve docstrings regarding raw_dir

ltelab · Nov 2, 2023 · 7744810 · 7744810
1 parent 9618f47
commit 7744810
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 7 deletions.
diff --git a/disdrodb/l0/check_readers.py b/disdrodb/l0/check_readers.py
@@ -126,7 +126,7 @@ def run_reader_on_test_data(data_source: str, campaign_name: str) -> None:
             station_name=station_name,
         )
 
-        # Define raw_dir and process_dir
+        # Define campaign_name raw_dir and process_dir
         raw_dir = get_disdrodb_path(
             base_dir=TEST_BASE_DIR,
             product_level="RAW",
@@ -141,7 +141,7 @@ def run_reader_on_test_data(data_source: str, campaign_name: str) -> None:
             campaign_name=campaign_name,
             check_exist=False,
         )
-
+        # Call the reader
         reader(
             raw_dir=raw_dir,
             processed_dir=processed_dir,

diff --git a/disdrodb/l0/io.py b/disdrodb/l0/io.py
@@ -269,8 +269,6 @@ def get_l0a_fname(df, processed_dir, station_name: str) -> str:
     starting_time = pd.to_datetime(starting_time).strftime("%Y%m%d%H%M%S")
     ending_time = pd.to_datetime(ending_time).strftime("%Y%m%d%H%M%S")
     campaign_name = _infer_campaign_name_from_path(processed_dir).replace(".", "-")
-    # metadata_dict = read_metadata(processed_dir, station_name)
-    # sensor_name = metadata_dict.get("sensor_name").replace("_", "-")
     version = PRODUCT_VERSION
     fname = f"L0A.{campaign_name}.{station_name}.s{starting_time}.e{ending_time}.{version}.parquet"
     return fname
@@ -299,8 +297,6 @@ def get_l0b_fname(ds, processed_dir, station_name: str) -> str:
     starting_time = pd.to_datetime(starting_time).strftime("%Y%m%d%H%M%S")
     ending_time = pd.to_datetime(ending_time).strftime("%Y%m%d%H%M%S")
     campaign_name = _infer_campaign_name_from_path(processed_dir).replace(".", "-")
-    # metadata_dict = read_metadata(processed_dir, station_name)
-    # sensor_name = metadata_dict.get("sensor_name").replace("_", "-")
     version = PRODUCT_VERSION
     fname = f"L0B.{campaign_name}.{station_name}.s{starting_time}.e{ending_time}.{version}.nc"
     return fname

diff --git a/disdrodb/l0/issue.py b/disdrodb/l0/issue.py
@@ -383,7 +383,7 @@ def read_issue(raw_dir: str, station_name: str) -> dict:
     Parameters
     ----------
     raw_dir : str
-        Path of the campaign raw directory.
+        RAW Directory path of the campaign.
     station_name : int
         Station name.