Skip to content

Commit

Permalink
Parameter description support
Browse files Browse the repository at this point in the history
Added support for the description field of parameters in Model.parameter()
  • Loading branch information
max3-2 authored and john-hen committed Feb 18, 2021
1 parent 0b111c2 commit b65fda5
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions mph/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ def rename(self, name):
"""Assigns a new `name` to the model."""
self.java.name(name)

def parameter(self, name, value=None, unit=None):
def parameter(self, name, value=None, unit=None, desc=None):
"""
Returns or sets the parameter of the given `name`.
Expand All @@ -164,8 +164,11 @@ def parameter(self, name, value=None, unit=None):
else:
value = str(value)
if unit:
value += f'[{unit}]'
self.java.param().set(name, value)
value += f' [{unit}]'
if desc is not None:
self.java.param().set(name, value, str(desc))
else:
self.java.param().set(name, value)

def load(self, file, interpolation):
"""
Expand Down

0 comments on commit b65fda5

Please sign in to comment.