docs(api): Remove deprecated behavior from api docs #7828
Conversation
plate.wells() was used when plate.well() should be used. I replaced all instances of plate.wells() with plate.well()
Codecov Report
@@ Coverage Diff @@
## edge #7828 +/- ##
=======================================
Coverage ? 83.49%
=======================================
Files ? 336
Lines ? 21347
Branches ? 0
=======================================
Hits ? 17823
Misses ? 3524
Partials ? 0 Continue to review full report at Codecov.
|
api/docs/v2/new_examples.rst
Outdated
| @@ -74,7 +74,7 @@ Loops in Python allow your protocol to perform many actions, or act upon many we | |||
|
|
|||
| # range() starts at 0 and stops before 8, creating a range of 0-7 | |||
| for i in range(8): | |||
| p300.distribute(200, reservoir.wells()[i], plate.rows()[i]) | |||
| p300.distribute(200, reservoir.well()[i], plate.rows()[i]) | |||
There was a problem hiding this comment.
This should still be .wells().
api/docs/v2/new_examples.rst
Outdated
| @@ -99,7 +99,7 @@ The OT-2 pipettes can do some things that a human cannot do with a pipette, like | |||
|
|
|||
| p300.pick_up_tip() | |||
|
|
|||
| for well in reservoir.wells()[:4]: | |||
| for well in reservoir.well()[:4]: | |||
api/docs/v2/new_examples.rst
Outdated
| @@ -128,13 +128,13 @@ This example first spreads a diluent to all wells of a plate. It then dilutes 8 | |||
| tiprack_2 = protocol.load_labware('opentrons_96_tiprack_300ul', 3) | |||
| reservoir = protocol.load_labware('usascientific_12_reservoir_22ml', 4) | |||
| p300 = protocol.load_instrument('p300_single', 'right', tip_racks=[tiprack_1, tiprack_2]) | |||
| p300.distribute(50, reservoir['A12'], plate.wells()) # dilutent | |||
| p300.distribute(50, reservoir['A12'], plate.well()) # dilutent | |||
There was a problem hiding this comment.
Same for this example as well.
api/docs/v2/new_examples.rst
Outdated
|
|
||
| # loop through each row | ||
| for i in range(8): | ||
|
|
||
| # save the source well and destination column to variables | ||
| source = reservoir.wells()[i] | ||
| source = reservoir.well()[i] |
api/docs/v2/new_examples.rst
Outdated
| @@ -44,8 +44,8 @@ This accomplishes the same thing as the following basic commands: | |||
| p300 = protocol.load_instrument('p300_single', 'right', tip_racks=[tiprack_1]) | |||
|
|
|||
| p300.pick_up_tip() | |||
| p300.aspirate(100, plate.wells('A1')) | |||
| p300.dispense(100, plate.wells('B1')) | |||
| p300.aspirate(100, plate.well('A1')) | |||
There was a problem hiding this comment.
Technically, this is deprecated behavior. I'm wondering if we should just remove this completely from the docs to discourage users from using this.
There was a problem hiding this comment.
Gotcha so wells can only be used with distribute/transfer?
I only tested this with the aspirate and assumed the others were just a typo.
There was a problem hiding this comment.
The deprecated behavior is that the well name is passed as an argument to the .wells() function, instead of as an index into the list that it returns.
In other words, instead of this:
plate.wells('B1')It should be one of these:
plate.wells()[1] # I *think* index 1 is B1?
# or
plate.wells_by_name()['B1']
# Edit to add: or this one too
plate['B1']Note that this method takes args for backward-compatibility, but use of args is deprecated and will be removed in future versions. Args can be either strings or integers, but must all be the same type (e.g.: self.wells(1, 4, 8) or self.wells(‘A1’, ‘B2’), but self.wells(‘A1’, 4) is invalid.
There was a problem hiding this comment.
I agree with Laura that our example code shouldn't be using the deprecated plate.wells(well_name) form.
There was a problem hiding this comment.
Sorry I'm not getting notifications on my github comments for some reason.
The equivalent of plate.well('B1') is now -> plate['B1']. If a user wants to have a list of wells, they should simply use python indexing; i.e. plate.wells()[0:7] which would give the first column of a 96 well labware.
@ethanfjones, I'm not sure I follow Gotcha so wells can only be used with distribute/transfer?. You can only use a single well when using the "atomic" commands such as aspirate or dispense. You can use a single well or a list of wells for advanced commands such as distribute or transfer.
There was a problem hiding this comment.
@Laura-Danielle and Mr. Syntax, thanks for the response.
Your explanation makes sense to me!
Laura-Danielle
changed the title
plate.wells() was used when plate.well() should be used. I replaced all instances of plate.wells() with plate.well()
Overview
Changelog
Review requests
Risk assessment