Skip to content

Commit 94bd0e9

Browse files
docs(api): clarify in docs that Well.has_tip checks only for unused tips (#17412)
Closes RQA-3790 # Overview `Well.has_tip` property has been checking for only clean/ unused tips since API v2.2 but the docstrings don't mention that. That has understandably caused some confusion in protocol behaviors. This PR helps mitigate that issue by clarifying the exact behavior of this property ## Risk assessment None. --------- Co-authored-by: Max Marrone <[email protected]>
1 parent cdb7802 commit 94bd0e9

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

api/src/opentrons/protocol_api/labware.py

+17-2
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,23 @@ def parent(self) -> Labware:
117117
@property
118118
@requires_version(2, 0)
119119
def has_tip(self) -> bool:
120-
"""Whether this well contains a tip. Always ``False`` if the parent labware
121-
isn't a tip rack."""
120+
"""Whether this well contains an unused tip.
121+
122+
From API v2.2 on:
123+
124+
- Returns ``False`` if:
125+
126+
- the well has no tip present, or
127+
- the well has a tip that's been used by the protocol previously
128+
129+
- Returns ``True`` if the well has an unused tip.
130+
131+
Before API v2.2:
132+
133+
- Returns ``True`` as long as the well has a tip, even if it is used.
134+
135+
Always ``False`` if the parent labware isn't a tip rack.
136+
"""
122137
return self._core.has_tip()
123138

124139
@has_tip.setter

0 commit comments

Comments
 (0)