Docs updates #111
Open
Docs updates #111
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
dbutenhof
requested changes
Dec 13, 2024
|
|
||
| Sometimes it is important to serialize workflow steps even if they do not have a data | ||
| passing relationship. An example may be running a series of benchmarks where you want to | ||
| ensure that you get valid results without one step interfereing with another. In this |
There was a problem hiding this comment.
"s/interfereing/interfering"
| Sometimes it is important to serialize workflow steps even if they do not have a data | ||
| passing relationship. An example may be running a series of benchmarks where you want to | ||
| ensure that you get valid results without one step interfereing with another. In this | ||
| case, you can use the `wait_for` option of the step to provide an expression or a oneof |
There was a problem hiding this comment.
Should "or a oneof condition" be linked to your new section on that topic?
|
|
||
| It is also possible to use oneof conditions as part of the `wait_for` flow control. An | ||
| explicit relationshp between steps in a workflow in this case becomes a oneof condition | ||
| for either the requested step output or otherwise the disabled state of the step. |
There was a problem hiding this comment.
The "otherwise" feels unnecessary here. This also implies explaining the implicit assumption that you're using "oneof" here because you're either running or disabling a step.
|
|
||
| Any time the input of a step relies on the output of another step via an [Arcaflow | ||
| expression](http://127.0.0.1:8000/arcaflow/workflows/expressions/), an implicit step | ||
| relationship is established. In this case, the Arcaflow engine holds the execution of the dependent step until the output from the supplier step is available. |
There was a problem hiding this comment.
This line doesn't wrap like the others.
Comment on lines
+343
to
+345
| It is also possible to use oneof conditions as part of the `wait_for` flow control. An | ||
| explicit relationshp between steps in a workflow in this case becomes a oneof condition | ||
| for either the requested step output or otherwise the disabled state of the step. |
There was a problem hiding this comment.
Typo: relationshp
Maybe also state that this will create an OR relationship that will allow the step to run either when the step is disabled OR when it gets the intended result.
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.
Changes introduced with this PR
Some fixes and cleanup of the getting started guide, and some expansion of the flow control docs.
By contributing to this repository, I agree to the contribution guidelines.