docs: Add comments to NodePhase definition. Closes #1117. #3467
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
alexec
reviewed
Jul 13, 2020
| NodeFailed NodePhase = "Failed" // a WF with a failed Node will be marked with NodeFailed as well | ||
| // There was an error within the container. E.g. the container exits with a non 0 code | ||
| NodeError NodePhase = "Error" // a WF with an errored Node will be marked with NodeError as well | ||
| // There was an error around a container, E.g. The pod was deleted, couldn’t be scheduled, or there were problems getting logs |
simster7
suggested changes
Jul 13, 2020
| NodeFailed NodePhase = "Failed" | ||
| NodeError NodePhase = "Error" | ||
| NodeOmitted NodePhase = "Omitted" | ||
| NodePending NodePhase = "Pending" // WF/Node is waiting to run |
There was a problem hiding this comment.
Suggested change
| NodePending NodePhase = "Pending" // WF/Node is waiting to run | |
| NodePending NodePhase = "Pending" // Node is waiting to run |
This is cleaner
| NodeSucceeded NodePhase = "Succeeded" // WF/Node has finished with no errors | ||
| NodeSkipped NodePhase = "Skipped" // Node was skipped in Workflow DAG / Steps | ||
| NodeFailed NodePhase = "Failed" // a WF with a failed Node will be marked with NodeFailed as well | ||
| // There was an error within the container. E.g. the container exits with a non 0 code |
There was a problem hiding this comment.
It's not standard to put a docstring below its definition. If it doesn't fit on the same line then all of the docstrings for this type should be above their definitions
There was a problem hiding this comment.
I would simply say "Node or child of node exited with non-0 code"
There was a problem hiding this comment.
I would simply say "Node or child of node exited with non-0 code"
This doesn't look addressed
simster7
suggested changes
Jul 14, 2020
| NodeSucceeded NodePhase = "Succeeded" // WF/Node has finished with no errors | ||
| NodeSkipped NodePhase = "Skipped" // Node was skipped in Workflow DAG / Steps | ||
| NodeFailed NodePhase = "Failed" // a WF with a failed Node will be marked with NodeFailed as well | ||
| // There was an error within the container. E.g. the container exits with a non 0 code |
There was a problem hiding this comment.
I would simply say "Node or child of node exited with non-0 code"
| // There was an error within the container. E.g. the container exits with a non 0 code | ||
| // a WF with a failed Node will be marked with NodeFailed as well | ||
| NodeFailed NodePhase = "Failed" | ||
| // There was an error around a container, E.g. The pod was deleted, couldn’t be scheduled, or there were problems getting logs |
There was a problem hiding this comment.
I would simply say "Node had an error other than a non-0 exit code"
Co-authored-by: Simon Behar <simbeh7@gmail.com>
Co-authored-by: Simon Behar <simbeh7@gmail.com>
Co-authored-by: Simon Behar <simbeh7@gmail.com>
Co-authored-by: Simon Behar <simbeh7@gmail.com>
simster7
suggested changes
Jul 14, 2020
| NodeSucceeded NodePhase = "Succeeded" // WF/Node has finished with no errors | ||
| NodeSkipped NodePhase = "Skipped" // Node was skipped in Workflow DAG / Steps | ||
| NodeFailed NodePhase = "Failed" // a WF with a failed Node will be marked with NodeFailed as well | ||
| // There was an error within the container. E.g. the container exits with a non 0 code |
There was a problem hiding this comment.
I would simply say "Node or child of node exited with non-0 code"
This doesn't look addressed
| // There was an error within the container. E.g. the container exits with a non 0 code | ||
| // a WF with a failed Node will be marked with NodeFailed as well | ||
| NodeFailed NodePhase = "Failed" | ||
| // Node had an error other than a non 0 exit code. E.g. The pod was deleted, couldn’t be scheduled, or there were problems getting logs |
There was a problem hiding this comment.
I would simply say "Node had an error other than a non-0 exit code"
This doesn't look addressed
simster7
approved these changes
Jul 15, 2020
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.
Checklist:
"fix(controller): Updates such and such. Fixes #1234".