-
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): describe new distribute()
volume clamping behavior
#14315
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
ecormany
added
docs
DO NOT MERGE
Indicates a PR should not be merged, even if there's a shiny green merge button available
papi-v2
Python API V2
labels
Jan 12, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## edge #14315 +/- ##
==========================================
- Coverage 67.79% 67.79% -0.01%
==========================================
Files 2518 2518
Lines 72017 72017
Branches 9244 9244
==========================================
- Hits 48826 48824 -2
- Misses 20989 20990 +1
- Partials 2202 2203 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
|
ecormany
changed the title
docs(api): describe new clamping behavior
docs(api): describe new Jan 12, 2024
distribute()
volume clamping behavior
jwwojak
reviewed
Jan 17, 2024
jwwojak
reviewed
Jan 17, 2024
SyntaxColoring
approved these changes
Feb 3, 2024
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.
All looks correct to me. Thanks!
Co-authored-by: Joe Wojak <jwojak@gmail.com>
ecormany
force-pushed
the
docs-dispense-note
branch
from
February 12, 2024 23:10
56a735a
to
12d8462
Compare
ecormany
removed
the
DO NOT MERGE
Indicates a PR should not be merged, even if there's a shiny green merge button available
label
Feb 15, 2024
ecormany
added a commit
that referenced
this pull request
Mar 6, 2024
* move and rewrite note * update versioning entry * "API version" instead of "version…of the API" Co-authored-by: Joe Wojak <jwojak@gmail.com> * revise note text * clean up dispense() docstring * get location out of volume --------- Co-authored-by: Joe Wojak <jwojak@gmail.com>
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
Brings the docs up to date with changes in #14253.
Tagged "do not merge" because this has PAPI 2.17 features. This PR should eventually be retargeted on the feature branch for the first robot stack version that supports 2.17.
Addresses RTC-383.
Test Plan
Check the sandbox.
Changelog
push_out
anymore)volume
argument ofdispense()
Review requests
Is there anything more we'd like to say about dispense volumes vis-a-vis push out? I drafted this but I think it's not actually a good real-world example.
Risk assessment
v v low, docs and docstrings only.