Skip to content

Commit

Permalink
docs(api): Refactor instrument-context docstrings (#13780)
Browse files Browse the repository at this point in the history
* Spelling check

Line 116, "millimiters" should be "millimeters".

* fix microliters abbreviation-use mu not u

Use "µL" instead of "uL".

* starting_tips, reset_tipracks, default_speed

* reset_tipracks description

* Sandbox test

* sandbox test

ignore

* aspirate and assoc arguments

* Aspirate and This instance

Inconsistent punctuation for the text ":returns: This instance." Sometimes ended with a period, sometimes not. Changed to end all instances w/ a period.

* blow_out

* blow_out code formatting to monospace

* configure_for_volume and e.g.

Too many instances of "eg". Should be "e.g.," or "e.g."

* configure_for_volume part 2

* current_volume, channels, default_speed

* dispense description-definitions

* dispense format testing

Not rendering in a nice way. Might be exceeding character count per line.

* dispense formatting test

Again, more line length testing.

* dispense format layout test

* drop tip and new anchor

Anchor to pipette_tips.rst, "Dropping a Tip" section. Anchor is .. _pipette-drop-tip:

* drop_tip text formatting

* drop_tip formatting yet again

* Punctuation, links, vol measurement units

* Mix

* mix text formatting

* Mix: more formatting

* Mix one more format try

* Adding an anchor

* air_gap volume text

Last minute, saw some weird original text to fix.

* Check and fix any remaining

Returning to this after problems last week. Just a few additional changes.

Ran Black on the file. Returns the following:

  joewojak@admins-Air-2 protocol_api % black
  instrument_context.py --diff --color
  All done! ✨ 🍰 ✨
  1 file would be left unchanged.

* Line 618 remove spaces, keep same line

Line count doesn't change

* Apply suggestions from code review

Making batch commits before other changes. Will do a batch commit, pull locally, more revisions, and push again.

Co-authored-by: Ed Cormany <[email protected]>

* Remove commas in introductory signals

For text like "See, . . . " and "See also, . . . " let's get rid of the commas.

Also, most, if not all, of these should be just "See" not "See also" because we're referring to stuff that directly supports the text.

* Style code formatting, text, and code sample

Single quotes made code italics. Replace with ``code`` to get monospace.

Remove * as a multiplication operator. Replace with "multiplied by".

Fix code sample in dispense.

Run Black check. Looks ok.

* Revisions from reviewers part 1

Incorporating reviewer comments.
- aspirate
- dispense
- reset_tipracks
- touch_tip
- remove (s)
- small adjustments

Not finished yet. More to come.

* Revisions from comments

- Replace (text only) "tiprack" with "tip rack"
- Fix single quotes around code elements. Replace with double single quotes (`not this`, but ``this instead``). Rendered text in italics.
- drop_tip revisions
- mount revisions, add "left" and "right"
- min_volume revision, add definition
- configure_for_volume changes

* Fogot to save recent and run Black

* Fix code snippet in touch_tip

Another instance of italics instead of monospace.

* Everything but the intro

* Revised intro

* batch of changes from final review

* Restore intro sentence to line 58

and run Black.

All done! ✨ 🍰 ✨
1 file reformatted.

---------

Co-authored-by: Ed Cormany <[email protected]>
  • Loading branch information
jwwojak and ecormany authored Oct 26, 2023
1 parent 861ebe8 commit a034c6e
Show file tree
Hide file tree
Showing 3 changed files with 232 additions and 221 deletions.
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

0 comments on commit a034c6e

Please sign in to comment.