From fcc3b608c9f37291bf16b7c9af40500abf9d382a Mon Sep 17 00:00:00 2001
From: ldam <ldam@passcal.nmt.edu>
Date: Mon, 21 Aug 2023 15:27:17 -0600
Subject: [PATCH] modify docstring

---
 sohstationviewer/view/util/functions.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/sohstationviewer/view/util/functions.py b/sohstationviewer/view/util/functions.py
index 72a7d069a..58e3faab6 100644
--- a/sohstationviewer/view/util/functions.py
+++ b/sohstationviewer/view/util/functions.py
@@ -334,7 +334,7 @@ def remove_not_found_chans(
     """
     Remove channels that are not found in actual_chans from chan_order.
 
-    :param chan_order: The list of channel that have channels end with '?'
+    :param chan_order: list of channels in order that user wants to plot
     :param actual_chans: The actual channel list
     :param processing_log: The log list to keep track with not found channels
     :return: chan_order from which not found channels have been removed.
@@ -365,6 +365,8 @@ def replace_actual_question_chans(
         if actual_question_chans:
             question_idx = chan_order.index(qc)
             chan_order.remove(qc)
+            # replace a question channel with the actual channels that it
+            # represent for
             chan_order[question_idx:question_idx] = \
                 sorted(actual_question_chans)
     return chan_order
-- 
GitLab