correct statement on return value of module write hook #715
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
Flamefire
reviewed
Jun 14, 2021
| * the filepath of the module that will be written | ||
| * the module text as a string | ||
| The return value of this hook (if any) will then be appended to the contents of the module file. | ||
| The return value of this hook (if any) is used as contents for the module file that will be written. |
Contributor
There was a problem hiding this comment.
TBH: I find "as contents for the file that will be written" a bit to complicated compared to "will be written to the file"
Maybe we could still clarify this a bit, especially with respect to "no return value/no hook":
Suggested change
| The return value of this hook (if any) is used as contents for the module file that will be written. | |
| The return value of this hook, when set, will replace the original text that is then written to the module file. |
Member
Author
There was a problem hiding this comment.
That's better indeed, opening another PR :)
Contributor
|
Going in, thanks @boegel! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
fix incorrect statement I introduced in #714 🙊