Skip to content

Commit

Permalink
More docstring tweaks.
Browse files Browse the repository at this point in the history
  • Loading branch information
SyntaxColoring committed Aug 6, 2024
1 parent 85a30d9 commit 4bd40f1
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions api/src/opentrons/simulate.py
Original file line number Diff line number Diff line change
Expand Up @@ -228,10 +228,9 @@ def get_protocol_api(
use_virtual_hardware: bool = True,
) -> protocol_api.ProtocolContext:
"""
Build and return a ``protocol_api.ProtocolContext``
connected to Virtual Smoothie.
Build and return a ``protocol_api.ProtocolContext`` that simulates robot control.
This can be used to run protocols from interactive Python sessions
This can be used to simulate protocols from interactive Python sessions
such as Jupyter or an interpreter on the command line:
.. code-block:: python
Expand Down Expand Up @@ -438,15 +437,15 @@ def simulate(
"""
Simulate the protocol itself.
This is a one-stop function to simulate a protocol, whether python or json,
no matter the api version, from external (i.e. not bound up in other
This is a one-stop function to simulate a protocol, whether Python or JSON,
no matter the API version, from external (i.e. not bound up in other
internal server infrastructure) sources.
To simulate an opentrons protocol from other places, pass in a file like
object as protocol_file; this function either returns (if the simulation
To simulate an opentrons protocol from other places, pass in a file-like
object as ``protocol_file``; this function either returns (if the simulation
has no problems) or raises an exception.
To call from the command line use either the autogenerated entrypoint
To call from the command line, use either the autogenerated entrypoint
``opentrons_simulate`` (``opentrons_simulate.exe``, on windows) or
``python -m opentrons.simulate``.
Expand Down Expand Up @@ -488,8 +487,9 @@ def simulate(
non-recursive contents of specified directories
are presented by the protocol context in
``protocol_api.ProtocolContext.bundled_data``.
:param hardware_simulator_file_path: A path to a JSON file defining a
hardware simulator.
:param hardware_simulator_file_path: A path to a JSON file defining the simulated
hardware. This is mainly for internal use by Opentrons, and is not necessary
to simulate protocols.
:param duration_estimator: For internal use only.
Optional duration estimator object.
:param propagate_logs: Whether this function should allow logs from the
Expand Down

0 comments on commit 4bd40f1

Please sign in to comment.