Skip to content

Commit 97b4ee9

Browse files
emilyburghardtcaila-marashaj
authored andcommitted
fixing reference errors
1 parent 497545c commit 97b4ee9

File tree

4 files changed

+11
-10
lines changed

4 files changed

+11
-10
lines changed

api/docs/v2/basic_commands/liquids.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ You can also aspirate from a location along the center vertical axis within a we
4949
pipette.aspirate(200, depth)
5050

5151

52-
Use the :py:meth:`~.Labware.Well.mensicus` method to aspirate relative to the meniscus of liquid in a well with a Flex pipette. First, you'll need to define the volume of liquid in your well:
52+
Use the :py:meth:`~.Well.meniscus` method to aspirate relative to the meniscus of liquid in a well with a Flex pipette. First, you'll need to define the volume of liquid in your well:
5353
- Specify your starting liquid volume with :py:meth:`~.Labware.load_liquid`, or
5454
- Use :py:meth:`~.InstrumentContext.measure_liquid_height` to define liquid height in a well before aspirating, or earlier in the protocol.
5555

@@ -119,7 +119,7 @@ You can also dispense from a location along the center vertical axis within a we
119119
pipette.dispense(200, depth)
120120

121121

122-
Use the :py:meth:`~.Labware.Well.Meniscus` method to dispense at the meniscus of liquid in your well with a Flex pipette. First, you'll need to define the volume of liquid in your well:
122+
Use the :py:meth:`~.Well.meniscus` method to dispense at the meniscus of liquid in your well with a Flex pipette. First, you'll need to define the volume of liquid in your well:
123123
- Specify your starting liquid volume with :py:meth:`~.Labware.load_liquid`, or
124124
- Use :py:meth:`~.InstrumentContext.measure_liquid_height` to define liquid height in a well before aspirating, or earlier in the protocol.
125125

api/docs/v2/new_protocol_api.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ Labware
2828
=======
2929
.. autoclass:: opentrons.protocol_api.Labware
3030
:members:
31-
:exclude-members: next_tip, use_tips, previous_tip, return_tips, load_empty, load_liquid, load_liquid_by_well
32-
31+
:exclude-members: next_tip, use_tips, previous_tip, return_tips
3332
..
3433
The trailing ()s at the end of TrashBin and WasteChute here hide the __init__()
3534
signatures, since users should never construct these directly.

api/docs/v2/robot_position.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -86,16 +86,17 @@ Let's look at the :py:meth:`.Well.center` method. It returns a position centered
8686
Meniscus
8787
^^^^^^^^
8888

89-
Let's look at the :py:meth:`~.Labware.well-meniscus` method. It returns a position at the surface of liquid, or meniscus, inside a well. Like the `.Well.top` and `.Well.bottom` methods, you can adjust the height of the meniscus with the optional argument ``z``, which is measured in mm. Positive ``z`` values move the position up, and negative ones move it down.
89+
Let's look at the :py:meth:`~.Well.meniscus` method. It returns a position at the surface of liquid, or meniscus, inside a well. Like the `.Well.top` and `.Well.bottom` methods, you can adjust the height of the meniscus with the optional argument ``z``, which is measured in mm. Positive ``z`` values move the position up, and negative ones move it down.
9090

9191
.. code-block:: python
9292
9393
plate["A1"].meniscus(target= "end", z=-1) # 1 mm below the meniscus of liquid inside the well
9494
9595
96-
The liquid meniscus in a well changes during aspirating or dispensing, so you'll also need to specify a ``target`` position for the pipette:
97-
- Set ``target= "end"`` to ensure the pipette stays submerged while aspirating.
98-
- Set ``target= "start"`` or ``end`` to choose where the pipette begins dispensing.
96+
The liquid meniscus in a well changes during aspirating or dispensing, so you'll also need to specify a ``target`` position relative to the meniscus. Each position target is useful in different scenarios:
97+
98+
- Set ``target= "start"`` to target the existing liquid meniscus in the destination well before an aspirate or dispense.
99+
- Set ``target= "end"`` to ensure the pipette stays submerged while aspirating, or to avoid touching liquid in the destination well while dispensing.
99100

100101
.. note::
101102
To use the :py:meth: `~.Labware.well-meniscus` method, you'll first need to determine the volume of liquid inside the well. You can do this at any time in your protocol by:

api/src/opentrons/protocol_api/labware.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -268,8 +268,9 @@ def meniscus(
268268
"""
269269
:param z: An offset on the z-axis, in mm. Positive offsets are higher and
270270
negative offsets are lower.
271-
:param target: The relative position inside the well to target when performing a liquid handling operation.
272-
:return: A :py:class:`~opentrons.types.Location` that indicates location is meniscus and that holds the ``z`` offset in its point.z field.
271+
:param target: The relative position of the liquid meniscus inside the well to target when performing a liquid handling operation.
272+
273+
:return: A :py:class:`~opentrons.types.Location` corresponding to the liquid meniscus, plus a target position and ``z`` offset as specified.
273274
274275
"""
275276
return Location(

0 commit comments

Comments
 (0)