Fix readme example and clarify comments #145
Merged
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.
I believe the example in the README.md is incorrect as the
name
parameter is specified as another element in thesteps
list, whereas I think it should be part of the same object as fielduses: JarvusInnovations/background-action@v1
.Also, I added some newlines to the inlined comments in the
with:
object to make it clearer which YAML lines the comments are associated with, namely the lines above, but not the lines below.