From 65eb71203a0fc8ee2630ce144c61a0f9c85b4e23 Mon Sep 17 00:00:00 2001 From: Edward Cormany Date: Thu, 2 May 2024 17:35:05 -0400 Subject: [PATCH] draft docstring for .params --- api/src/opentrons/protocol_api/protocol_context.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/api/src/opentrons/protocol_api/protocol_context.py b/api/src/opentrons/protocol_api/protocol_context.py index feb8f56d91c..07c4bdfff5d 100644 --- a/api/src/opentrons/protocol_api/protocol_context.py +++ b/api/src/opentrons/protocol_api/protocol_context.py @@ -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: