refactor(api): Flesh out developer documentation for unsafe commands#18151
Merged
Conversation
sfoster1
approved these changes
Apr 22, 2025
TamarZanzouri
approved these changes
Apr 22, 2025
Contributor
TamarZanzouri
left a comment
TamarZanzouri
left a comment
There was a problem hiding this comment.
thank you for doing this!
| therefore never be used in protocols, and should only be used otherwise as a last | ||
| resort. | ||
|
|
||
| These exist as a necessary evil for implementing things like error recovery. |
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
ddcc4
pushed a commit
that referenced
this pull request
May 16, 2025
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
ddcc4
pushed a commit
that referenced
this pull request
May 17, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
Edit a docstring to elaborate on the meaning of "unsafe" Protocol Engine commands, following an in-person discussion with @sfoster1 and @ahiuchingau.
Changelog
opentrons.protocol_engine.commands.unsafemodule docstring.Review requests
Is this clearer? Anything else to add?
This part is something that I'm adding on-the-fly. We haven't discussed it. Does this seem like a good expectation?
Risk assessment
No risk.