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-building-block-commands #13376

Merged
merged 15 commits into from
Sep 26, 2023

Commits on Aug 24, 2023

  1. Adding comments to make different from edge

    At top of the doc, these comments should be deleted when we're done. Had to add something to make the branch code different from edge. Can't easily open a PR if the branch and edge are the same. Simple comments easier than forcing an empty commit.
    jwwojak committed Aug 24, 2023
    Configuration menu
    Copy the full SHA
    aed62f2 View commit details
    Browse the repository at this point in the history
  2. Revised summary and new intro sections

    Revised the intro paragraph that summarizes the page contents. Also, added the intro sections on how the page code is structured, what labware/instruments are used, and include base protocol code for Flex and OT-2 in tabs.
    jwwojak committed Aug 24, 2023
    Configuration menu
    Copy the full SHA
    ed0e881 View commit details
    Browse the repository at this point in the history

Commits on Aug 28, 2023

  1. Remove repeated content labware and protocol

    This was the content used in the Examples section. Removing it because it's long and repetitious. Instead, each section will include a short sentence linking to the protocol file template/example.
    jwwojak committed Aug 28, 2023
    Configuration menu
    Copy the full SHA
    9a9ce4b View commit details
    Browse the repository at this point in the history

Commits on Sep 7, 2023

  1. docs(api): refactor-tip-handling (#13383)

    * New pickup tip text and code samples
    
    Includes a revised section header and intro. Focus is on pick_up_tip method.
    
    * tips revisions: iterate, drop, return, and used
    
    3 sections.
    
    The original "iterate through tips" becomes a section on loops and tip pickup.
    
    Then, the doc picks up from the original with drop tips, return tips.
    
    Final section cleans up info about using "used" tips.
    
    More after lunch revisions to come.
    
    * Minor text adjustment
    
    * Used tips text, small edits
    
    * Tips section finish up and a first review
    
    Will run through again on Monday. Checked code snippets with base code sample/protocol. They work. Formatting via Black formatter style.
    
    * Minor text and space adjustments
    
    * Monday morning review and minor adjustments
    
    * Tips intro, simplify last sentence
    
    * Adding protocol template text and link
    
    * Apply suggestions from code review
    
    Returning to the tip handling section. Committing previous review comments.
    
    Co-authored-by: Ed Cormany <[email protected]>
    
    * Saving stashed changes after batch commit
    
    to keep text synched up
    
    * Fixed conflicts, restored H2 section header
    
    * Basic tip pick up and using a loop for pickup
    
    * Automating tip pickup intro
    
    Something weird going on. Trying again.
    
    * Working with used tips
    
    * Small changes in tip manipulation section.
    
    * API raise error, not throw an error
    
    ---------
    
    Co-authored-by: Ed Cormany <[email protected]>
    jwwojak and ecormany authored Sep 7, 2023
    Configuration menu
    Copy the full SHA
    7cb545f View commit details
    Browse the repository at this point in the history
  2. docs(api): Refactor liquid control section (#13396)

    * New branch for Liquid Control section
    
    Added a comment to make this different from the branch, docs-refactor-building-blocks-commands to create a draft PR.
    
    * Adjust section header, make H2
    
    Need to make simple change to switch to a different branch.
    
    * Touch tip, blow out, dispense revisions
    
    Plus a few others throughout before lunch.
    
    * Touch tip revisions
    
    * Revisions to Mix section
    
    * Air gap section revisions
    
    * Add text and link to protocol template code
    
    * End of day review edits
    
    * Remove horizontal line between sections
    
    * Aspirate section revisions
    
    * Finish aspirate revisions, start dispense
    
    * Start dispense, end of day push
    
    * Final review of aspirate, start dispense
    
    * Dispense and aspirate revisions done for now
    
    Moving on to next sections.
    
    * Blow out revisions
    
    * Starting touch tip revisions, add option sections
    
    * touch_tip and blow_out text, short small changes
    
    * Mix revisions
    
    * Mix revisions
    
    * Air gap revisions, finish Liquid Handling section
    
    Utility commands next.
    
    * Remove intro bullet list, fix Aspirate headers
    
    * Apply suggestions from code review
    
    Co-authored-by: Ed Cormany <[email protected]>
    
    * API versions capitalization and case
    
    * Mix and air_gap changes, make similar, use text
    
    * add shortcut, revise remaining liquid sections
    
    - add shortcut to "Move To" section in robot_position
    - Revisions to liquid handling sections after Aspirate/Dispense
    - Blow out
    - Touch tip
    - Mix
    - Air gap
    
    Done for now, ready for another review.
    
    * Suggested word change-that's it for Friday
    
    In text linking to another doc, changing "well" to "pipette."
    
    Th
    
    * Small edits to air gap and touch tip
    
    Minor sentence changes. Will call this done.
    
    * Apply suggestions from code review
    
    Batch commit. Another check and more changes to come.
    
    Co-authored-by: Ed Cormany <[email protected]>
    
    * Update api/docs/v2/new_atomic_commands.rst
    
    Co-authored-by: Ed Cormany <[email protected]>
    
    * Let's get rid of some lets
    
    * Touch tip update
    
    * Let's look for more lets
    
    ---------
    
    Co-authored-by: Ed Cormany <[email protected]>
    jwwojak and ecormany authored Sep 7, 2023
    Configuration menu
    Copy the full SHA
    f48e112 View commit details
    Browse the repository at this point in the history
  3. docs(api): Refactor utility commands section (#13406)

    * Creating stub PR for Utility section
    
    For Building Block Commands doc.
    
    * Fix section headers
    
    * Start section summary
    
    * Section intro starting draft save
    
    * Section intro - add full method links
    
    * Section comments removed.
    
    * Delay method revisions
    
    * Utility commands intro, delay/resume, pause meths
    
    * Homing, lights, and comments
    
    * Door safety switch section
    
    * Homing and safety switch adjustments
    
    * Utility last check
    
    * Utility intro changes
    
    * Delay/resume, pause, rail light checks
    
    * Intro and comment features
    
    * Minor edits to comment and homing
    
    * Making reviewer changes
    
    * Utility delete image, fix homing
    jwwojak authored Sep 7, 2023
    Configuration menu
    Copy the full SHA
    f22bfaa View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    50a2328 View commit details
    Browse the repository at this point in the history

Commits on Sep 20, 2023

  1. Configuration menu
    Copy the full SHA
    499ec3f View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    9dea7ea View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    a6f0f1c View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    f3216e9 View commit details
    Browse the repository at this point in the history

Commits on Sep 21, 2023

  1. Configuration menu
    Copy the full SHA
    6559031 View commit details
    Browse the repository at this point in the history
  2. Small edit to summary intro

    jwwojak committed Sep 21, 2023
    Configuration menu
    Copy the full SHA
    ba3ad44 View commit details
    Browse the repository at this point in the history

Commits on Sep 26, 2023

  1. Apply suggestions from code review

    Co-authored-by: Ed Cormany <[email protected]>
    jwwojak and ecormany authored Sep 26, 2023
    Configuration menu
    Copy the full SHA
    fc93da5 View commit details
    Browse the repository at this point in the history
  2. Final updates

    jwwojak committed Sep 26, 2023
    Configuration menu
    Copy the full SHA
    2f6d11f View commit details
    Browse the repository at this point in the history