Skip to content

Commit

Permalink
updated docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
pmoegenburg committed Sep 20, 2024
1 parent 64fc6e2 commit 1bcc578
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
5 changes: 2 additions & 3 deletions api/src/opentrons/protocol_engine/commands/aspirate.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@ async def execute(self, params: AspirateParams) -> _ExecuteReturn:
pipette_id = params.pipetteId
labware_id = params.labwareId
well_name = params.wellName
volume = params.volume

ready_to_aspirate = self._pipetting.get_is_ready_to_aspirate(
pipette_id=pipette_id
Expand Down Expand Up @@ -119,7 +118,7 @@ async def execute(self, params: AspirateParams) -> _ExecuteReturn:
well_name=well_name,
well_location=params.wellLocation,
current_well=current_well,
operation_volume=-volume,
operation_volume=-params.volume,
)
deck_point = DeckPoint.construct(x=position.x, y=position.y, z=position.z)
state_update.set_pipette_location(
Expand All @@ -132,7 +131,7 @@ async def execute(self, params: AspirateParams) -> _ExecuteReturn:
try:
volume_aspirated = await self._pipetting.aspirate_in_place(
pipette_id=pipette_id,
volume=volume,
volume=params.volume,
flow_rate=params.flowRate,
command_note_adder=self._command_note_adder,
)
Expand Down
5 changes: 4 additions & 1 deletion api/src/opentrons/protocol_engine/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,10 @@ class WellOffset(BaseModel):


class WellVolumeOffset(BaseModel):
"""A z-offset to account for volume in an operation."""
"""A volume of liquid to account for when executing commands with an origin of WellOrigin.MENISCUS.
For example, this parameter should be used for MoveToWell commands prior to AspirateInPlace commands.
"""

volumeOffset: Union[float, Literal["operationVolume"]] = 0.0

Expand Down

0 comments on commit 1bcc578

Please sign in to comment.