docs(api): overhaul Labware docstrings
#14401
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 #14401 +/- ##
==========================================
- Coverage 68.24% 68.16% -0.08%
==========================================
Files 2514 2514
Lines 71868 71854 -14
Branches 9176 9176
==========================================
- Hits 49044 48981 -63
- Misses 20657 20706 +49
Partials 2167 2167
Flags with carried forward coverage won't be shown. Click here to find out more.
|
ecormany
requested review from
jwwojak and
SyntaxColoring
and removed request for
a team
jwwojak
reviewed
Feb 2, 2024
jwwojak
reviewed
Feb 2, 2024
andySigler
pushed a commit
that referenced
this pull request
Feb 15, 2024
Carlos-fernandez
pushed a commit
that referenced
this pull request
May 20, 2024
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
Freshen up the
Labwareclass in the API Reference.Addresses RTC-205.
Test Plan
Check the sandbox.
Changelog
Review requests
Take a careful look at the simplifications I made in
set_offset. I think we need to more fully address what the current state of that function is. The ticket referenced in the TODO just above the error handling logic has been closed. I think that function should be usable again, but I won't put the docs ahead of the API's actual capabilities.Risk assessment
none, docs