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): update Deck Slots page for new features in Python API 2.16 #14146

Merged
merged 7 commits into from
Dec 12, 2023

Conversation

ecormany
Copy link
Contributor

@ecormany ecormany commented Dec 7, 2023

Overview

Significantly expands the Deck Slots page of the Python docs to include the concept of deck configuration introduced in PAPI 2.16 / robot software 7.1.0.

Test Plan

Check out the sandbox.

Changelog

  • Update the deck map SVG to show installed staging slots on Flex.
  • Add info on working area vs. staging area
  • New, large section on deck configuration
    • what it is
    • subsections for each type of fixture
    • how the app handles protocol–config conflicts

Review requests

  • Will this make sense to users who are approaching deck configuration for the first time?
  • Will this page still work for OT-2 users who don't care about deck configuration at all?
  • Do all my code snippets work? ⭐

Risk assessment

v low, docs

Copy link

codecov bot commented Dec 7, 2023

Codecov Report

Merging #14146 (9f21c89) into chore_release-7.1.0 (4ab2000) will decrease coverage by 0.04%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@                   Coverage Diff                   @@
##           chore_release-7.1.0   #14146      +/-   ##
=======================================================
- Coverage                70.46%   70.43%   -0.04%     
=======================================================
  Files                     2512     2483      -29     
  Lines                    71231    70346     -885     
  Branches                  8978     8784     -194     
=======================================================
- Hits                     50195    49545     -650     
+ Misses                   18838    18643     -195     
+ Partials                  2198     2158      -40     
Flag Coverage Δ
g-code-testing 96.44% <ø> (ø)
notify-server 89.13% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
api/src/opentrons/protocol_api/protocol_context.py 92.30% <ø> (ø)

... and 31 files with indirect coverage changes

@ecormany ecormany added docs papi-v2 Python API V2 labels Dec 8, 2023
@ecormany ecormany marked this pull request as ready for review December 11, 2023 15:29
@ecormany ecormany requested a review from a team as a code owner December 11, 2023 15:29
Copy link
Contributor

@jwwojak jwwojak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few optional comments for consideration.

api/docs/v2/deck_slots.rst Outdated Show resolved Hide resolved
api/docs/v2/deck_slots.rst Show resolved Hide resolved
Deck Configuration
==================

A Flex running robot system version 7.1.0 or higher lets you specify its deck configuration on the touchscreen or in the Opentrons App. This tells the robot the positions of unpowered *deck fixtures*: items that replace standard deck slots. The following table lists currently supported deck fixtures and their allowed deck locations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The colon here makes the sentence abrupt. What about something like this:

"This tells the robot the positions of unpowered deck fixtures, which are items that replace standard deck slots).

Or even:

"This tells the robot the positions of unpowered deck fixtures (items that replace standard deck slots).

Or 2 sentences:

"This tells the robot the positions of unpowered deck fixtures. These are items that replace standard deck slots.

api/docs/v2/deck_slots.rst Show resolved Hide resolved
api/docs/v2/deck_slots.rst Outdated Show resolved Hide resolved
api/docs/v2/deck_slots.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@SyntaxColoring SyntaxColoring left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huzzah.

api/docs/v2/deck_slots.rst Outdated Show resolved Hide resolved
api/docs/v2/deck_slots.rst Show resolved Hide resolved
@ecormany ecormany force-pushed the docs-deck-slots-2.16 branch from 05fd0c9 to 917ff1f Compare December 12, 2023 20:01
@ecormany ecormany merged commit 8134602 into chore_release-7.1.0 Dec 12, 2023
25 checks passed
@ecormany ecormany deleted the docs-deck-slots-2.16 branch October 16, 2024 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs papi-v2 Python API V2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants