-
Notifications
You must be signed in to change notification settings - Fork 179
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): runtime parameters in Python API 2.18 #14677
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## docs_release-2.18 #14677 +/- ##
====================================================
Coverage ? 67.20%
====================================================
Files ? 2495
Lines ? 71406
Branches ? 8992
====================================================
Hits ? 47985
Misses ? 21305
Partials ? 2116
Flags with carried forward coverage won't be shown. Click here to find out more.
|
c00a37f
to
b6f5201
Compare
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.
Awesome additions to the API docs. I did leave some comments. Please take a look.
cdecc11
to
a55d47a
Compare
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.
This is awesome!
Still going through the PR, just minor corrections so far.
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.
Just the above comments from me. Everything else looks great!
Doesn't have to be in this PR but I'm wondering if it would be useful to have screenshots of the app flow to help understand the significance of all the parameters' arguments (display name/ description/ choices, etc).
Thanks for the comments! I've deliberately kept the UI out of the Python docs (here and elsewhere). Although I hope that we'll have a video or some other visual resource that I can link to from one of these pages, either in time for release or shortly after. |
Co-authored-by: Sanniti Pimpley <[email protected]>
Overview
Full documentation for setting up and using runtime parameters in Python protocols.
Closes RTC-416, RTC-428, RTC-429, RTC-430, RTC-451
Test Plan
Changelog
ProtocolContext.params
in API Reference.Note, this still needs a docstring, either here or in a separate PR.Added docstring.Review requests
Read some or all of it, try the code, tell me what can be better.
Risk assessment
None