updated the outputs in readme.md #22
Open
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
3 tasks
webknjaz
reviewed
Aug 9, 2023
| @@ -108,18 +108,16 @@ in security breach "dangerous") side-effects. | |||
|
|
|||
| ### ``failure`` | |||
|
|
|||
| Whether this check decided that the job matrix failed. | |||
|
|
|||
| This check determines whether the job matrix has failed and returns the status as `success`. | |||
There was a problem hiding this comment.
This doesn't look right. Why would failure be a success?
webknjaz
reviewed
Aug 9, 2023
|
|
||
| ### ``result`` | ||
|
|
||
| Failure or success result of the job matrix. | ||
| returns `failure` or `success` as result of the job matrix. |
There was a problem hiding this comment.
It's probably worth noting that these are strings and make the sentence start with a capital letter.
Suggested change
| returns `failure` or `success` as result of the job matrix. | |
| Returns `'failure'` or `'success'` as result of the job matrix. |
webknjaz
reviewed
Aug 9, 2023
|
|
||
|
|
||
| ### ``success`` | ||
|
|
||
| Whether this check decided that the job matrix succeeded. | ||
|
|
||
| This check determines whether the job matrix has succeeded and returns the status as `success`. |
There was a problem hiding this comment.
I don't think this is correct. Pretty sure, both success and failure outputs are true or false. Only result contains a string 'success' or 'failure'.
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.
Resolves #21