Skip to content

Commit

Permalink
Adding documentation in input specs to HERON_DATA
Browse files Browse the repository at this point in the history
  • Loading branch information
joshua-cogliati-inl committed Apr 8, 2024
1 parent 206acdc commit 1ee33e7
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/Placeholders.py
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,7 @@ def get_input_specs(cls):
The RAVEN ARMA ROM should be trained and serialized before using it in HERON. The text
of this node indicates the location of the serialized ROM. This location is usually relative
with respect to the HERON XML input file; however, a full absolute path can be used,
or the path can be prepended with ``\%HERON_DATA\%'' to be relative to the HERON data directory (``HERON/data'' in the git repository, but the location of ``\%HERON_DATA\%'' can be overridden by exporting a ``HERON_DATA'' environmental variable),
or the path can be prepended with ``\%HERON\%'' to be relative to the installation
directory of HERON.""")
specs.addParam('name', param_type=InputTypes.StringType, required=True,
Expand Down Expand Up @@ -261,6 +262,7 @@ def get_input_specs(cls):
Python functions have access to the variables within the dispatcher. The text
of this node indicates the location of the python file. This location is usually relative
with respect to the HERON XML input file; however, a full absolute path can be used,
or the path can be prepended with ``\%HERON_DATA\%'' to be relative to the HERON data directory (``HERON/data'' in the git repository, but the location of ``\%HERON_DATA\%'' can be overridden by exporting a ``HERON_DATA'' environmental variable),
or the path can be prepended with ``\%HERON\%'' to be relative to the installation
directory of HERON.""")
specs.addParam('name', param_type=InputTypes.StringType, required=True,
Expand Down

0 comments on commit 1ee33e7

Please sign in to comment.