Add TODO comments

E3SM-Project · Jan 28, 2025 · 47ef624 · 47ef624
1 parent df39bf4
commit 47ef624
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/e3sm_diags/e3sm_diags_driver.py b/e3sm_diags/e3sm_diags_driver.py
@@ -392,6 +392,8 @@ def main(parameters=[]) -> List[CoreParameter]:  # noqa B006
             if not os.path.exists(path):
                 os.makedirs(path)
 
+            # TODO: This is where the path is passed for the viewer, which
+            # is where the index.html is stored.
             index_path = create_viewer(path, parameters_results)
             logger.info("Viewer HTML generated at {}".format(index_path))
 

diff --git a/e3sm_diags/viewer/main.py b/e3sm_diags/viewer/main.py
@@ -77,6 +77,8 @@ def insert_data_in_row(row_obj, name, url):
         row_obj.append(td)
 
     path = os.path.join(e3sm_diags.INSTALL_PATH, "viewer", "index_template.html")
+    # TODO: root_dir is the results_dir with "viewer" appended to it. We
+    # want the index.html to work in the results_dir too.
     output = os.path.join(root_dir, "index.html")
 
     soup = BeautifulSoup(open(path), "lxml")