Skip to content

Commit

Permalink
expand dispense location docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
ecormany committed Mar 7, 2024
1 parent e15a920 commit 2308641
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions api/src/opentrons/protocol_api/instrument_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -306,21 +306,25 @@ def dispense( # noqa: C901
:type volume: int or float
:param location: Tells the robot where to dispense liquid held in the pipette.
The location can be a :py:class:`.Well`, :py:class:`.Location`,
:py:class:`.TrashBin`, or :py:class:`.WasteChute`.
The location can be a :py:class:`.Well`, :py:class:`.Location`,
:py:class:`.TrashBin`, or :py:class:`.WasteChute`.
- If the location is a ``Well``, the pipette will dispense
- If a ``Well``, the pipette will dispense
at or above the bottom center of the well. The distance (in
mm) from the well bottom is specified by
:py:obj:`well_bottom_clearance.dispense
<well_bottom_clearance>`.
- If the location is a ``Location`` (e.g., the result of
:py:meth:`.Well.top` or :py:meth:`.Well.bottom`), the robot
will dispense into that specified position.
- If a ``Location`` (e.g., the result of
:py:meth:`.Well.top` or :py:meth:`.Well.bottom`), the pipette
will dispense at that specified position.
- If the ``location`` is unspecified, the robot will
dispense into its current position.
- If a trash container, the pipette will dispense at a location
relative to its center and the trash container's top center.
See :ref:`position-relative-trash` for details.
- If unspecified, the pipette will
dispense at its current position.
If only a ``location`` is passed (e.g.,
``pipette.dispense(location=plate['A1'])``), all of the
Expand Down

0 comments on commit 2308641

Please sign in to comment.