Docs: Updated no return await documentation (fixes #9695) #10699
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
Get latest from ESLint
eslint-deprecated
bot
added
the
triage
marla294
changed the title
marla294
changed the title
marla294
changed the title
marla294
changed the title
marla294
changed the title
marla294
changed the title
|
I'm not sure why the commit message (PR Title) is failing... if someone will tell me what I'm doing wrong I'll update it. Thanks! |
not-an-aardvark
changed the title
not-an-aardvark
approved these changes
Jul 29, 2018
|
Ah! Not sure how that happened, but thanks! I'll be watching this issue in case anyone has any other suggestions. |
not-an-aardvark
added
documentation
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)
Updated documentation for 'no-return-await' rule page. Reworded to make it clear that return await is usually unnecessary but there is 1 exception (trying to catch errors from a Promise-based function). Hopefully this will make folks coming to this rule page happy and we can close this issue.
Is there anything you'd like reviewers to focus on?
Yes, please make sure the wording is to your liking. Also I said from a "promise-based" function - I think this is correct (the function could be a promise or it could be an async function) but I'm not 100% sure, lmk if that is incorrect. Thanks!