Skip to content
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

Merged
merged 33 commits into from
May 14, 2024
Merged

Conversation

ecormany
Copy link
Contributor

@ecormany ecormany commented Mar 15, 2024

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

  • New landing page for Runtime Parameters
  • 6 new subpages
  • Unhide 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

Copy link

codecov bot commented Mar 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (docs_release-2.18@a55d47a). Click here to learn what that means.

❗ Current head 3d5e701 differs from pull request most recent head 3b8926b. Consider uploading reports for the commit 3b8926b to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@                 Coverage Diff                  @@
##             docs_release-2.18   #14677   +/-   ##
====================================================
  Coverage                     ?   67.20%           
====================================================
  Files                        ?     2495           
  Lines                        ?    71406           
  Branches                     ?     8992           
====================================================
  Hits                         ?    47985           
  Misses                       ?    21305           
  Partials                     ?     2116           
Flag Coverage Δ
g-code-testing 92.43% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
...i/src/opentrons/protocol_api/instrument_context.py 89.09% <ø> (ø)

@ecormany ecormany changed the base branch from edge to docs_release-2.18 March 29, 2024 22:15
@ecormany ecormany added docs papi-v2 Python API V2 labels Apr 2, 2024
@ecormany ecormany force-pushed the docs_release-2.18 branch from c00a37f to b6f5201 Compare April 19, 2024 20:49
@ecormany ecormany marked this pull request as ready for review May 1, 2024 21:52
@ecormany ecormany requested a review from a team as a code owner May 1, 2024 21:52
@ecormany ecormany requested a review from jwwojak May 1, 2024 21:52
Copy link
Contributor

@jwwojak jwwojak left a 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.

api/docs/v2/parameters/defining.rst Show resolved Hide resolved
api/docs/v2/parameters/style.rst Outdated Show resolved Hide resolved
api/docs/v2/parameters/style.rst Show resolved Hide resolved
api/docs/v2/parameters/style.rst Show resolved Hide resolved
api/docs/v2/parameters/use_case_dry_run.rst Outdated Show resolved Hide resolved
api/docs/v2/parameters/use_case_dry_run.rst Show resolved Hide resolved
api/docs/v2/parameters/use_case_sample_count.rst Outdated Show resolved Hide resolved
@ecormany ecormany force-pushed the docs_release-2.18 branch from cdecc11 to a55d47a Compare May 2, 2024 20:53
Copy link
Member

@sanni-t sanni-t left a 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.

api/docs/v2/parameters/choosing.rst Outdated Show resolved Hide resolved
api/docs/v2/parameters/choosing.rst Outdated Show resolved Hide resolved
api/docs/v2/parameters/defining.rst Outdated Show resolved Hide resolved
api/docs/v2/parameters/defining.rst Outdated Show resolved Hide resolved
api/docs/v2/parameters/defining.rst Outdated Show resolved Hide resolved
api/docs/v2/parameters/defining.rst Outdated Show resolved Hide resolved
api/docs/v2/parameters/defining.rst Outdated Show resolved Hide resolved
api/docs/v2/parameters/style.rst Show resolved Hide resolved
@ecormany ecormany changed the title docs(api): draft RTP docs docs(api): runtime parameters in Python API 2.18 May 3, 2024
Copy link
Member

@sanni-t sanni-t left a 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).

@ecormany
Copy link
Contributor Author

ecormany commented May 3, 2024

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.

@ecormany ecormany merged commit 1a45161 into docs_release-2.18 May 14, 2024
20 checks passed
@ecormany ecormany deleted the docs-rtp branch October 16, 2024 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs papi-v2 Python API V2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants