Skip to content

Commit

Permalink
expand tip_racks and active_channels docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
ecormany committed Dec 7, 2023
1 parent 93c879a commit 79df294
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions api/src/opentrons/protocol_api/instrument_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -1636,7 +1636,11 @@ def channels(self) -> int:
@property # type: ignore
@requires_version(2, 16)
def active_channels(self) -> int:
"""The number of channels configured for active use using configure_nozzle_layout()."""
"""The number of channels the pipette will use to pick up tips.
By default, all channels on the pipette. Use :py:meth:`.configure_nozzle_layout`
to set the pipette to use fewer channels.
"""
return self._core.get_active_channels()

@property # type: ignore
Expand Down Expand Up @@ -1815,7 +1819,21 @@ def configure_nozzle_layout(
*left-to-right* from a tip rack. Use ``"A12"`` to have the pipette use its
rightmost nozzles to pick up tips *right-to-left* from a tip rack.
:type start: str or ``None``
:param tip_racks: List of tip racks to use during this configuration.
:param tip_racks: Behaves the same as setting the ``tip_racks`` parameter of
:py:meth:`.load_instrument`. If not specified,
:py:obj:`.InstrumentContext.tip_racks` will be reset to ``None`` and you
must specify the location every time you call
:py:meth:`~.InstrumentContext.pick_up_tip`.
To keep the same list of tip racks when changing configurations, reference
the same instrument's existing ``tip_racks`` parameter::
pipette.configure_nozzle_layout(
style=COLUMN,
tip_racks=pipette.tip_racks
)
:type tip_racks: List[:py:class:`.Labware`]
"""
# TODO: add the following back into the docstring when QUADRANT is supported
#
Expand Down

0 comments on commit 79df294

Please sign in to comment.