Skip to content

Commit 7ea49b1

Browse files
print_outputs_rich method doc with TODO re: issues with current implementation and need to refactor to use client pattern that maintains Outputs.PrintOutputs as canonical source of truth for output logic
1 parent 6ba776d commit 7ea49b1

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/geophires_x/OutputsRich.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,13 @@ def __init__(self, parameter: str, value: str = '', units: str = ''):
4444

4545

4646
def print_outputs_rich(output_file: str, text_output_file: strParameter, html_output_file: strParameter, model: Model):
47+
"""
48+
TODO Implementation of rich output in this method/file is duplicative of Outputs.PrintOutputs. This adds undue
49+
code complexity, maintenance overhead, inconsistency, and potential for bugs. Rich output should instead be
50+
generated in a module that uses GeophiresXClient or an equivalent pattern which maintains Outputs.PrintOutputs
51+
as the ultimate source of truth/authority for output logic.
52+
"""
53+
4754
# data structures and assignments for HTML and Improved Text Output formats
4855
simulation_metadata = []
4956
summary = []

0 commit comments

Comments
 (0)