@@ -1526,11 +1526,32 @@ def transfer_with_liquid_class(
1526
1526
return_tip : bool = False ,
1527
1527
visit_every_well : bool = False ,
1528
1528
) -> InstrumentContext :
1529
- """Transfer liquid from source to dest using the specified liquid class properties .
1529
+ """Move a particular type of liquid from one well or group of wells to another .
1530
1530
1531
- TODO: Add args description.
1531
+ :param liquid_class: The type of liquid to move. You must specify the liquid class,
1532
+ even if you have used :py:meth:`.load_liquid` to indicate what liquid the
1533
+ source contains.
1534
+ :type liquid_class: :py:class:`.LiquidClass`
1532
1535
1533
- :meta private:
1536
+ :param volume: The amount, in µL, to aspirate from each source and dispense to
1537
+ each destination.
1538
+ :param source: A single well or a list of wells to aspirate liquid from.
1539
+ :param dest: A single well or a list of wells to dispense liquid into.
1540
+ :param new_tip: When to pick up and drop tips during the command.
1541
+ Defaults to ``"once"``.
1542
+
1543
+ - ``"once"``: Use one tip for the entire command.
1544
+ - ``"always"``: Use a new tip for each set of aspirate and dispense steps.
1545
+ - ``"per source"``: Use one tip for each source well, even if
1546
+ :ref:`tip refilling <complex-tip-refilling>` is required.
1547
+ - ``"never"``: Do not pick up or drop tips at all.
1548
+
1549
+ See :ref:`param-tip-handling` for details.
1550
+
1551
+ :param trash_location: A trash container, well, or other location to dispose of
1552
+ tips. Depending on the liquid class, the pipette may also blow out liquid here.
1553
+ :param return_tip: Whether to drop used tips in their original locations
1554
+ in the tip rack, instead of the trash.
1534
1555
"""
1535
1556
transfer_args = verify_and_normalize_transfer_args (
1536
1557
source = source ,
@@ -1590,12 +1611,30 @@ def distribute_with_liquid_class(
1590
1611
visit_every_well : bool = False ,
1591
1612
) -> InstrumentContext :
1592
1613
"""
1593
- Distribute liquid from a single source to multiple destinations
1594
- using the specified liquid class properties.
1614
+ Distribute a particular type of liquid from one well to a group of wells.
1595
1615
1596
- TODO: Add args description.
1616
+ :param liquid_class: The type of liquid to move. You must specify the liquid class,
1617
+ even if you have used :py:meth:`.load_liquid` to indicate what liquid the
1618
+ source contains.
1619
+ :type liquid_class: :py:class:`.LiquidClass`
1597
1620
1598
- :meta private:
1621
+ :param volume: The amount, in µL, to aspirate from the source and dispense to
1622
+ each destination.
1623
+ :param source: A single well to aspirate liquid from.
1624
+ :param dest: A list of wells to dispense liquid into.
1625
+ :param new_tip: When to pick up and drop tips during the command.
1626
+ Defaults to ``"once"``.
1627
+
1628
+ - ``"once"`` or ``"per source"``: Use one tip for the entire command.
1629
+ - ``"always"``: Use a new tip for each set of aspirate and dispense steps.
1630
+ - ``"never"``: Do not pick up or drop tips at all.
1631
+
1632
+ See :ref:`param-tip-handling` for details.
1633
+
1634
+ :param trash_location: A trash container, well, or other location to dispose of
1635
+ tips. Depending on the liquid class, the pipette may also blow out liquid here.
1636
+ :param return_tip: Whether to drop used tips in their original locations
1637
+ in the tip rack, instead of the trash.
1599
1638
"""
1600
1639
transfer_args = verify_and_normalize_transfer_args (
1601
1640
source = source ,
@@ -1659,12 +1698,31 @@ def consolidate_with_liquid_class(
1659
1698
visit_every_well : bool = False ,
1660
1699
) -> InstrumentContext :
1661
1700
"""
1662
- Consolidate liquid from multiple sources to a single destination
1663
- using the specified liquid class properties.
1701
+ Consolidate a particular type of liquid from a group of wells to one well.
1664
1702
1665
- TODO: Add args description.
1703
+ :param liquid_class: The type of liquid to move. You must specify the liquid class,
1704
+ even if you have used :py:meth:`.load_liquid` to indicate what liquid the
1705
+ source contains.
1706
+ :type liquid_class: :py:class:`.LiquidClass`
1666
1707
1667
- :meta private:
1708
+ :param volume: The amount, in µL, to aspirate from the source and dispense to
1709
+ each destination.
1710
+ :param source: A list of wells to aspirate liquid from.
1711
+ :param dest: A single well to dispense liquid into.
1712
+ :param new_tip: When to pick up and drop tips during the command.
1713
+ Defaults to ``"once"``.
1714
+
1715
+ - ``"once"``: Use one tip for the entire command.
1716
+ - ``"always"``: Use a new tip for each set of aspirate and dispense steps.
1717
+ - ``"per source"``: Not available when consolidating.
1718
+ - ``"never"``: Do not pick up or drop tips at all.
1719
+
1720
+ See :ref:`param-tip-handling` for details.
1721
+
1722
+ :param trash_location: A trash container, well, or other location to dispose of
1723
+ tips. Depending on the liquid class, the pipette may also blow out liquid here.
1724
+ :param return_tip: Whether to drop used tips in their original locations
1725
+ in the tip rack, instead of the trash.
1668
1726
"""
1669
1727
transfer_args = verify_and_normalize_transfer_args (
1670
1728
source = source ,
0 commit comments