From 2e75718d91279b444629afc9964841e4d13f0c44 Mon Sep 17 00:00:00 2001
From: Maeva Pourpoint <maeva@passcal.nmt.edu>
Date: Thu, 9 Sep 2021 09:03:58 -0600
Subject: [PATCH] Add example of LEMI-424 filename in scan_path2data docstring
---
lemi2seed/lemi_data.py | 2 ++
1 file changed, 2 insertions(+)
diff --git a/lemi2seed/lemi_data.py b/lemi2seed/lemi_data.py
index 7ea4b45..4a98335 100644
--- a/lemi2seed/lemi_data.py
+++ b/lemi2seed/lemi_data.py
@@ -57,6 +57,8 @@ class LemiData():
"""
Scan data directory provided by the user for LEMI generated data files.
LEMI-424 filenaming covention: YYYYMMDDHHMM.TXT
+ Ex: .../DATA0110/202009302105.TXT
+ where ".../DATA0110/" is the user-provided path to their dataset.
"""
data_files = [tmp for tmp in Path(self.path2data).glob('*')
if re.match(r"^\w{12}.txt$", tmp.parts[-1], re.IGNORECASE)]
--
GitLab