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.

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): Refactor instrument-context docstrings #13780

Merged
merged 41 commits into from
Oct 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
ea7d51e
Spelling check
jwwojak Oct 10, 2023
a9f7928
fix microliters abbreviation-use mu not u
jwwojak Oct 10, 2023
21d16a3
starting_tips, reset_tipracks, default_speed
jwwojak Oct 11, 2023
49f3e70
reset_tipracks description
jwwojak Oct 11, 2023
ad96ba7
Sandbox test
jwwojak Oct 11, 2023
91034ec
sandbox test
jwwojak Oct 11, 2023
4af8fe0
aspirate and assoc arguments
jwwojak Oct 11, 2023
6bc0835
Aspirate and This instance
jwwojak Oct 11, 2023
ef26717
blow_out
jwwojak Oct 11, 2023
6ca3bb7
blow_out code formatting to monospace
jwwojak Oct 11, 2023
6c245cd
configure_for_volume and e.g.
jwwojak Oct 11, 2023
08949b3
configure_for_volume part 2
jwwojak Oct 11, 2023
9287abd
current_volume, channels, default_speed
jwwojak Oct 11, 2023
586b4fd
dispense description-definitions
jwwojak Oct 12, 2023
362f097
dispense format testing
jwwojak Oct 12, 2023
d4b9609
dispense formatting test
jwwojak Oct 12, 2023
040f5d5
dispense format layout test
jwwojak Oct 12, 2023
d608ca0
drop tip and new anchor
jwwojak Oct 12, 2023
52e622a
drop_tip text formatting
jwwojak Oct 12, 2023
c8f0baf
drop_tip formatting yet again
jwwojak Oct 12, 2023
f9104b6
Punctuation, links, vol measurement units
jwwojak Oct 12, 2023
76f0503
Mix
jwwojak Oct 12, 2023
66f346e
mix text formatting
jwwojak Oct 12, 2023
990bdec
Mix: more formatting
jwwojak Oct 12, 2023
d58a971
Mix one more format try
jwwojak Oct 12, 2023
50f7022
Adding an anchor
jwwojak Oct 12, 2023
827c866
air_gap volume text
jwwojak Oct 12, 2023
1b47670
Check and fix any remaining
jwwojak Oct 18, 2023
9649223
Merge branch 'edge' into instrument-context-docstrings
jwwojak Oct 18, 2023
4673f02
Line 618 remove spaces, keep same line
jwwojak Oct 18, 2023
a1c38a4
Apply suggestions from code review
jwwojak Oct 20, 2023
b911197
Remove commas in introductory signals
jwwojak Oct 20, 2023
b77c25d
Style code formatting, text, and code sample
jwwojak Oct 20, 2023
8fc2d90
Revisions from reviewers part 1
jwwojak Oct 23, 2023
8d90e61
Revisions from comments
jwwojak Oct 24, 2023
9f029f9
Fogot to save recent and run Black
jwwojak Oct 24, 2023
77faa56
Fix code snippet in touch_tip
jwwojak Oct 24, 2023
1d06051
Everything but the intro
jwwojak Oct 25, 2023
fa6d0e8
Revised intro
jwwojak Oct 25, 2023
3f1c36a
batch of changes from final review
ecormany Oct 26, 2023
b757772
Restore intro sentence to line 58
jwwojak Oct 26, 2023
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
4 changes: 4 additions & 0 deletions api/docs/v2/basic_commands/pipette_tips.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Your robot needs to attach a disposable tip to the pipette before it can aspirat

The following sections demonstrate how to use each method and include sample code. The examples used here assume that you've loaded the pipettes and labware from the basic :ref:`protocol template <protocol-template>`.

.. _basic-tip-pickup:

Picking Up a Tip
================

Expand Down Expand Up @@ -70,6 +72,8 @@ Finally, sum the tip count in the range::

For a more advanced "real-world" example, review the :ref:`off-deck location protocol <off-deck-location>` on the :ref:`moving-labware` page. This example also uses a ``for`` loop to iterate through a tip rack, but it includes other commands that pause the protocol and let you replace an on-deck tip rack with another rack stored in an off-deck location.

.. _pipette-drop-tip:

Dropping a Tip
==============

Expand Down
2 changes: 2 additions & 0 deletions api/docs/v2/basic_commands/utilities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Call the :py:meth:`.ProtocolContext.pause` method to stop a protocol at a specif

.. versionadded:: 2.0

.. _utility-homing:

Homing
======

Expand Down
Loading
Loading