Clarify that always() has a side effect
#8411
Merged
Conversation
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
One straight-forward interpretation of the previous wording was that the function simply always returns `true`, with no other side effects. A reasonable conclusion would then be that, in an `if` expression, `&& always()` is redundant, and can be omitted. However, this in incorrect, as the function does have the side effect of forcing the step to be executed in addition to returning `true`.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
github-actions
bot
added
the
triage
|
@CyberShadow Thanks so much for opening a PR! I'll get this triaged for review ⚡ |
ramyaparimi
added
actions
Adriamo132
approved these changes
Jul 22, 2021
This comment has been minimized.
This comment has been minimized.
skedwards88
approved these changes
Jul 28, 2021
github-actions
bot
removed
the
waiting for review
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
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.
One straight-forward interpretation of the previous wording was that the function simply always returns
true, with no other side effects. A reasonable conclusion would then be that, in anifexpression,&& always()is redundant, and can be omitted. However, this in incorrect, as the function does have the side effect of forcing the step to be executed in addition to returningtrue.Why:
(This is a relatively minor change, does it need an issue?)
What's being changed:
Just the description of the
always()function.Check off the following: