-
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
style(api): Revise execute/simulate reference docstrings #15901
Conversation
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.
Yeah, that looks like a good set of changes
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.
Looks good, only improves things — although I spotted a couple more formatting changes you could add.
Maybe the rare opportunity for "style(api)" in the PR title.
Co-authored-by: Ed Cormany <[email protected]>
Co-authored-by: Ed Cormany <[email protected]>
oooo rare commit tag, gimme |
protocol. This is preparation for a beta feature | ||
and is best not used. |
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.
Guys, I'm not sure where or how this text appears, but would recommend changing the last part of the sentence "and is best not used" to something like "and should not be used."
Or
Try 2 shorter sentences, "This is in preparation for a beta feature. Do not use it."
protocol. Note that if you specify this, *only* | ||
labware in this argument will be allowed in the | ||
protocol. This is preparation for a beta feature | ||
and is best not used. |
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.
Another "best not used" phrase. From my suggestion above, I'd recommend changing that part of the sentence to something like "and should not be used."
Or, try 2 shorter sentences, "This is in preparation for a beta feature. Do not use it." A stronger admonition if people shouldn't use this.
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.
Added some suggestions for consideration.
Overview
Minor adjustments to the reference docstrings in
opentrons.simulate
andopentrons.execute
.Test Plan and Hands on Testing
I've skimmed the generated docs and made sure this doesn't introduce any flagrant formatting problems.
Changelog
Python
instead ofpython
.Review requests
Is
chore_release-8.0.0
the correct merge target?Risk assessment
No risk.