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): Python Protocol API 2.17 #14493

Merged
merged 2 commits into from
Mar 6, 2024
Merged

docs(api): Python Protocol API 2.17 #14493

merged 2 commits into from
Mar 6, 2024

Conversation

ecormany
Copy link
Contributor

@ecormany ecormany commented Feb 14, 2024

This is a feature branch for documenting changes in version 2.17 of the Python Protocol API.

Please base all 2.17-related documentation PRs on this branch!


Well, we only had one PR before deciding to bump the API version to 2.17. So I'm fixing up this branch and treating it as a regular PR to edge, which we'll squash-merge.

Copy link

codecov bot commented Feb 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.50%. Comparing base (d2696ce) to head (18bc645).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             edge   #14493   +/-   ##
=======================================
  Coverage   67.50%   67.50%           
=======================================
  Files        2514     2514           
  Lines       72376    72376           
  Branches     9317     9317           
=======================================
  Hits        48857    48857           
  Misses      21314    21314           
  Partials     2205     2205           
Flag Coverage Δ
g-code-testing 92.43% <ø> (ø)

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

Files Coverage Δ
...i/src/opentrons/protocol_api/instrument_context.py 89.09% <ø> (ø)

@DerekMaggio
Copy link
Contributor

Protocol for exercising error being thrown for dispensing more than current volume in API v2.17
https://github.com/Opentrons/opentrons/pull/14569/files#diff-6c1e40766e7f20b14d1f75292b6633786c59784ddf74197b21c49cfb985aba29

* move and rewrite note

* update versioning entry

* "API version" instead of "version…of the API"

Co-authored-by: Joe Wojak <[email protected]>

* revise note text

* clean up dispense() docstring

* get location out of volume

---------

Co-authored-by: Joe Wojak <[email protected]>
@ecormany ecormany force-pushed the docs_release-2.17 branch from 1bb01a9 to 4cfb58f Compare March 6, 2024 19:14
Copy link
Member

@sfoster1 sfoster1 left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@ecormany ecormany merged commit d6f22ac into edge Mar 6, 2024
22 checks passed
Carlos-fernandez pushed a commit that referenced this pull request May 20, 2024
Documenting changes in version 2.17 of the Python Protocol API

---------

Co-authored-by: Joe Wojak <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants