-
Notifications
You must be signed in to change notification settings - Fork 178
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): miscellaneous changes for version 2.16 #14265
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## edge #14265 +/- ##
=======================================
Coverage 68.05% 68.05%
=======================================
Files 2509 2509
Lines 71343 71343
Branches 9063 9063
=======================================
Hits 48556 48556
Misses 20684 20684
Partials 2103 2103
Flags with carried forward coverage won't be shown. Click here to find out more. |
.. versionadded:: 2.0 | ||
|
||
.. note:: | ||
Returning tips isn't allowed when using :ref:`partial tip pickup <partial-tip-pickup>`. The API will raise an error. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything in this PR is great. This last note stood out to me. Please give it some consideration.
-
You can't return tips when using
partial tip pickup
. The API will raise an error. -
The API will raise an error if you try to return tips using
partial tip pickup
.
Or make it more explicit:
- The
return_tip()
method does not work withpartial tip pickup
. You can only usereturn_tip()
when picking up a full set up tips. <-- last sentence is weak, but the idea is return_tip only works with a "default" type of pickup.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is great! Only one comment about a note for return_tip
.
🚀
@@ -34,7 +34,7 @@ You also need to specify ``'robotType': 'Flex'``. If you omit ``robotType`` in t | |||
metadata = { | |||
"protocolName": "My Protocol", | |||
"description": "This protocol uses the OT-2", | |||
"apiLevel": "2.14" | |||
"apiLevel": "|apiLevel|" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noice
Overview
This PR ties up a bunch of loose ends around the Python API version 2.16 release.
There's no guarantee that this has caught everything, but it should be sufficient for the initial
docs@2.16
deploy. Any further changes can be made in subsequent PRs and deployed separately.Test Plan
Take a good look through the sandbox. This PR touches a bunch of pages.
Changelog
configure.rst
topartial_tip_pickup.rst
— should have been done in the initial refactor.load_trash_bin()
to Flex snippets that need it.|apiLevel|
substitution — we don't need to hold these back anymore.Review requests
👀👀👀
Risk assessment
no code risk. low-ish docs risk. nothing that can't be fixed later.