docs(api): miscellaneous changes for version 2.16 #14265
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
jwwojak
reviewed
Dec 22, 2023
| .. 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.
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.
jwwojak
approved these changes
Dec 22, 2023
sanni-t
approved these changes
Dec 22, 2023
| @@ -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|" | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.16deploy. 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.rsttopartial_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.