Docs: Adds an example with try/catch. #9672
Merged
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
Clarifies with an example that `return await` inside an error handler is allowed by this rule.
|
|
aladdin-add
approved these changes
Dec 1, 2017
platinumazure
approved these changes
Dec 1, 2017
ilyavolodin
approved these changes
Dec 1, 2017
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What is the purpose of this pull request? (put an "X" next to item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Clarifies with an example that
return awaitinside an error handler is allowed by this rule.The rule correctly implements this, but the docs didn't reflect that.
Is there anything you'd like reviewers to focus on?
The reason I added the example is because many developers will memorize
return awaitis unnecessary. Having an error handler makes it necessary. Since this rule allows user to avoid unnecessaryreturn await, it's probably a good thing to make them aware that sometimes it is required.