Skip to content

Commit 163a297

Browse files
docs(api): clarify in docs that Well.has_tip checks only for unused tips (#17455)
Cherry-picked commit for 8.3.0 release branch Original PR: #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 741382d commit 163a297

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

api/src/opentrons/protocol_api/labware.py

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

122137
@has_tip.setter

0 commit comments

Comments
 (0)