Skip to content

Commit

Permalink
expanded param documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
PaulTalbot-INL committed Jun 13, 2024
1 parent 1d0bab7 commit 2f5d9d6
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/ValuedParams/Factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,12 @@ def make_input_specs(self, name, descr=None, allowed=None, kind='singular'):
)
addl_spec = InputData.parameterInputFactory(
'AdditionalInfo',
descr=r"""Additional arbitrary input information. TODO more info."""
descr=r"""Additional arbitrary input information. For custom-defined parameters, such as \xmlNode{Function},
the additional information will be passed as part of the `texttt{meta[``HERON''][``custom_input'']}
passed to the user-supplied custom evaluation definition.
In the case of the \xmlNode{Function}, this is passed to the method in the Python module indicated by
the user, and will be unique for each use of the \xmlNode{Function} in the HERON input. Note that
the custom input nodes are not checked in any way by the input parsing."""
)
addl_spec.setStrictMode(False)
spec.addSub(addl_spec)
Expand Down

0 comments on commit 2f5d9d6

Please sign in to comment.