Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(api): clarify in docs that Well.has_tip checks only for unused tips #17455

Merged
merged 1 commit into from
Feb 6, 2025
Merged

docs(api): clarify in docs that Well.has_tip checks only for unused tips #17455

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions api/src/opentrons/protocol_api/labware.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,23 @@ def parent(self) -> Labware:
@property
@requires_version(2, 0)
def has_tip(self) -> bool:
"""Whether this well contains a tip. Always ``False`` if the parent labware
isn't a tip rack."""
"""Whether this well contains an unused tip.

From API v2.2 on:

- Returns ``False`` if:

- the well has no tip present, or
- the well has a tip that's been used by the protocol previously

- Returns ``True`` if the well has an unused tip.

Before API v2.2:

- Returns ``True`` as long as the well has a tip, even if it is used.

Always ``False`` if the parent labware isn't a tip rack.
"""
return self._core.has_tip()

@has_tip.setter
Expand Down