Skip to content

Commit

Permalink
draft docstring for .params
Browse files Browse the repository at this point in the history
  • Loading branch information
ecormany committed May 2, 2024
1 parent f086614 commit 65eb712
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions api/src/opentrons/protocol_api/protocol_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,15 @@ def bundled_data(self) -> Dict[str, bytes]:
@property
@requires_version(2, 18)
def params(self) -> Parameters:
"""
The values of runtime parameters, as set during run setup.
Each attribute of this object corresponds to the ``variable_name`` of a parameter.
See :ref:`using-rtp` for details.
Parameter values can only be set during run setup. If you try to alter the value
of any attribute of ``params``, the API will raise an error.
"""
return self._params

def cleanup(self) -> None:
Expand Down

0 comments on commit 65eb712

Please sign in to comment.