Docs: improve documentation of no-return-await #13215
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
eslint-deprecated
bot
added
the
triage
kaicataldo
suggested changes
Apr 24, 2020
kaicataldo
added
documentation
Co-Authored-By: Kai Cataldo <kai@kaicataldo.com>
Co-Authored-By: Kai Cataldo <kai@kaicataldo.com>
|
Thanks @kaicataldo! I incorporated both of your changes. Let me know if you want me to squash this |
|
@kaicataldo anything else I can do to move this forward? |
kaicataldo
suggested changes
May 14, 2020
kaicataldo
removed
the
evaluating
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
|
@kaicataldo No worries, great suggestions! I've committed them ✔️ |
|
Awesome, thanks for the merge! 👏 |
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.
this is a resubmit of eslint/archive-website#716 but to the correct repo☺️
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an 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)
First of all, I know that there have been a lot of discussions on wether this rule is a good one or not. I do not want to bring up that discussion here at all. I just want to clarify the documentation to better explain the implications, I don't want to advocate for either turning this rule on or off.
I've had some team member asking why we are using
return await, especially after reading the current version of the documentation forno-return-await. The reason we are usingreturn awaitis because otherwise the functions are missing from the stack traces if an error is thrown asynchronously in the promise that is being returned.My intention with this change is to document that pitfall, and to clarify exactly what is being skipped when not using
return await(that is, that the function is either still on the call stack, or not)I'm very open to suggestion on more improvements that we can do here! ❤️
Is there anything you'd like reviewers to focus on?
n/a