version table + touch up dispense()

Opentrons · Mar 6, 2024 · 18bc645 · 18bc645
1 parent 4cfb58f
commit 18bc645
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/api/docs/v2/versioning.rst b/api/docs/v2/versioning.rst
@@ -84,6 +84,8 @@ This table lists the correspondence between Protocol API versions and robot soft
 +-------------+------------------------------+
 | API Version | Introduced in Robot Software |
 +=============+==============================+
+|     2.17    |          7.2.0               |
++-------------+------------------------------+
 |     2.16    |          7.1.0               |
 +-------------+------------------------------+
 |     2.15    |          7.0.0               |

diff --git a/api/src/opentrons/protocol_api/instrument_context.py b/api/src/opentrons/protocol_api/instrument_context.py
@@ -297,6 +297,12 @@ def dispense(  # noqa: C901
                            of the protocol. In API version 2.16 and earlier, dispense all
                            liquid in the pipette (same as unspecified or ``None``). In API
                            version 2.17 and later, dispense no liquid.
+
+                         - If greater than :py:obj:`.current_volume`, the behavior of
+                           ``dispense()`` depends on the API level of the protocol. In API
+                           version 2.16 and earlier, dispense all liquid in the pipette.
+                           In API version 2.17 and later, raise an error.
+
         :type volume: int or float
 
         :param location: Tells the robot where to dispense liquid held in the pipette.
@@ -343,6 +349,9 @@ def dispense(  # noqa: C901
 
         .. versionchanged:: 2.15
             Added the ``push_out`` parameter.
+
+        .. versionchanged:: 2.17
+            Behavior of the ``volume`` parameter.
         """
         if self.api_version < APIVersion(2, 15) and push_out:
             raise APIVersionError(