Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Update require-await docs with exception (fixes #9540) #11063

Merged
merged 3 commits into from Nov 9, 2018

Conversation

@nzakas
Copy link
Member

commented Nov 7, 2018

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 the docs for require-await to explain why you might not want to use it. Also, expanded the rule's description. It seems like this rule really needed a lot more documentation than it had.

Is there anything you'd like reviewers to focus on?

Does everything make sense?

@platinumazure
Copy link
Member

left a comment

Minor typos, otherwise LGTM. Thanks!

docs/rules/require-await.md Outdated Show resolved Hide resolved
docs/rules/require-await.md Outdated Show resolved Hide resolved
@platinumazure
Copy link
Member

left a comment

LGTM, thanks!

@btmills
Copy link
Member

left a comment

One last typo, then LGTM 👍

docs/rules/require-await.md Outdated Show resolved Hide resolved
@btmills

btmills approved these changes Nov 9, 2018

Copy link
Member

left a comment

LGTM

@nzakas nzakas merged commit 57f357e into master Nov 9, 2018

3 of 5 checks passed

continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
commit-message PR title follows commit message guidelines
Details
licence/cla Contributor License Agreement is signed.
Details
release-monitor No patch release is pending
Details

@nzakas nzakas deleted the issue9540 branch Nov 9, 2018

@eslint eslint bot locked and limited conversation to collaborators May 9, 2019

@eslint eslint bot added the archived due to age label May 9, 2019

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
4 participants
You can’t perform that action at this time.