From 40720fdbcb9030c6245915b51382a49d4e5586d9 Mon Sep 17 00:00:00 2001
From: ldam <ldam@passcal.nmt.edu>
Date: Wed, 30 Aug 2023 08:26:22 -0600
Subject: [PATCH] docstring for remove_question_mark()

---
 sohstationviewer/model/reftek_data/log_info.py        |  4 ++--
 sohstationviewer/model/reftek_data/log_info_helper.py | 10 ++++++++--
 2 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/sohstationviewer/model/reftek_data/log_info.py b/sohstationviewer/model/reftek_data/log_info.py
index 1ba6f822e..486efcb06 100644
--- a/sohstationviewer/model/reftek_data/log_info.py
+++ b/sohstationviewer/model/reftek_data/log_info.py
@@ -6,7 +6,7 @@ from sohstationviewer.controller.util import (
     get_time_6, get_time_4, get_val, rtn_pattern)
 from sohstationviewer.view.util.enums import LogType
 from sohstationviewer.model.reftek_data.log_info_helper import (
-    remove_question_mark)
+    remove_question_marks)
 
 if TYPE_CHECKING:
     from sohstationviewer.model.reftek_data.reftek import RT130
@@ -35,7 +35,7 @@ class LogInfo():
         self.key = key
         self.unit_id, self.exp_no = key
         self.req_data_streams = req_data_streams
-        self.no_question_req_soh_chans = remove_question_mark(req_soh_chans)
+        self.no_question_req_soh_chans = remove_question_marks(req_soh_chans)
         self.is_log_file = is_log_file
         """
         track_year to add year to time since year time not include year after
diff --git a/sohstationviewer/model/reftek_data/log_info_helper.py b/sohstationviewer/model/reftek_data/log_info_helper.py
index 282ca5cb2..3c3180ed0 100644
--- a/sohstationviewer/model/reftek_data/log_info_helper.py
+++ b/sohstationviewer/model/reftek_data/log_info_helper.py
@@ -1,8 +1,14 @@
-def remove_question_mark(req_soh_chan):
+def remove_question_marks(req_soh_chan):
+    """
+    Remove the question marks in the channel request list, req_soh_chan
+    :param req_soh_chan: soh channel request list
+    :return no_question_req_soh_chan: the channel request list with the
+        question marks removed
+    """
     no_question_req_soh_chan = []
     for idx, req in enumerate(req_soh_chan):
         if req.endswith('?'):
             no_question_req_soh_chan.append(req_soh_chan[idx][:-1])
         else:
             no_question_req_soh_chan.append(req_soh_chan[idx])
-    return no_question_req_soh_chan
\ No newline at end of file
+    return no_question_req_soh_chan
-- 
GitLab