Skip to content

Commit 7953430

Browse files
Include description in output parameter docs
1 parent 3b07381 commit 7953430

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

src/geophires_x/Parameter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ class OutputParameter(HasQuantity):
6464

6565
Name: str = ""
6666
value: int = 0
67-
ToolTipText: str = "This is ToolTip Text"
67+
ToolTipText: str = ""
6868
UnitType: IntEnum = Units.NONE
6969
PreferredUnits: Enum = Units.NONE
7070
# set to PreferredUnits by default assuming that the current units are the preferred units -

src/geophires_x_schema_generator/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,7 @@ def get_output_params_table_rst(self, output_params_json) -> str:
210210
:header-rows: 1
211211
212212
* - Name
213+
- Description
213214
- Preferred Units
214215
- Default Value Type"""
215216

@@ -223,6 +224,7 @@ def get_key(k):
223224
return ''
224225

225226
output_rst += f"""\n * - {param['Name']}
227+
- {get_key('ToolTipText')}
226228
- {get_key('PreferredUnits')}
227229
- {get_key('json_parameter_type')}"""
228230

0 commit comments

Comments
 (0)