Skip to content

Commit

Permalink
docs(api): overhaul ProtocolContext docstrings (#14376)
Browse files Browse the repository at this point in the history

---------

Co-authored-by: Max Marrone <max@opentrons.com>
  • Loading branch information
ecormany and SyntaxColoring authored Feb 2, 2024
1 parent fcfd56e commit 94bde86
Show file tree
Hide file tree
Showing 4 changed files with 168 additions and 139 deletions.
1 change: 1 addition & 0 deletions api/docs/v2/moving_labware.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ When the move step is complete, the API updates the labware's location, so you c
For the first move, the API knows to find the plate in its initial load location, slot D1. For the second move, the API knows to find the plate in D2.

.. _automatic-manual-moves:

Automatic vs Manual Moves
=========================
Expand Down
2 changes: 2 additions & 0 deletions api/docs/v2/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@ Whether you need a ``requirements`` block depends on your robot model and API ve

With the metadata and requirements defined, you can move on to creating the ``run()`` function for your protocol.

.. _run-function:

The ``run()`` function
----------------------

Expand Down
2 changes: 2 additions & 0 deletions api/docs/v2/versioning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ When choosing an API level, consider what features you need and how widely you p

On the one hand, using the highest available version will give your protocol access to all the latest :ref:`features and fixes <version-notes>`. On the other hand, using the lowest possible version lets the protocol work on a wider range of robot software versions. For example, a protocol that uses the Heater-Shaker and specifies version 2.13 of the API should work equally well on a robot running version 6.1.0 or 6.2.0 of the robot software. Specifying version 2.14 would limit the protocol to robots running 6.2.0 or higher.

.. _max-version:

Maximum Supported Versions
==========================

Expand Down
Loading

0 comments on commit 94bde86

Please sign in to comment.