Skip to content

Commit

Permalink
docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
TamarZanzouri committed May 16, 2024
1 parent b63f97c commit 3ed461b
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion api/src/opentrons/protocol_runner/run_orchestrator.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@


class RunOrchestrator:
"""Provider for runners and associated protocol engine."""
"""Provider for runners and associated protocol engine.
Build runners, manage command execution, run state and in-memory protocol engine associated to the runners.
"""

_protocol_runner: Optional[
Union[protocol_runner.JsonRunner, protocol_runner.PythonAndLegacyRunner, None]
Expand All @@ -31,6 +34,16 @@ def __init__(
] = None,
run_id: Optional[str] = None,
) -> None:
"""Initialize a run orchestrator interface.
Arguments:
protocol_engine: Protocol engine instance.
hardware_api: Hardware control API instance.
fixit_runner: LiveRunner for fixit commands.
setup_runner: LiveRunner for setup commands.
json_or_python_protocol_runner: JsonRunner/PythonAndLegacyRunner for protocol commands.
run_id: run id if any, associated to the runner/engine.
"""
self.run_id = run_id
self._protocol_engine = protocol_engine
self._hardware_api = hardware_api
Expand Down

0 comments on commit 3ed461b

Please sign in to comment.