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

Jump to bottom

Docs: clarify correct example in no-return-await (fixes #13656) #13657

Merged
merged 2 commits into from Sep 9, 2020
Merged

Docs: clarify correct example in no-return-await (fixes #13656) #13657

merged 2 commits into from Sep 9, 2020

Conversation

mdjermanovic
Copy link
Member

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:

fixes #13656

What changes did you make? (Give an overview)

  • Added a comment above an example that could be misinterpreted.
  • Also added missing eslint directives.

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

@mdjermanovic mdjermanovic added rule Relates to ESLint's core rules documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion labels Sep 5, 2020
@mdjermanovic mdjermanovic mentioned this pull request Sep 5, 2020
Closed
anikethsaha
anikethsaha suggested changes Sep 8, 2020
View reviewed changes
Copy link
Member

@anikethsaha anikethsaha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One optional thought

docs/rules/no-return-await.md Show resolved Hide resolved
@mdjermanovic mdjermanovic merged commit 17b58b5 into master Sep 9, 2020
@mdjermanovic mdjermanovic deleted the issue13656 branch September 9, 2020 23:53
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Mar 18, 2021
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Mar 18, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@btmills btmills btmills approved these changes

@anikethsaha anikethsaha anikethsaha approved these changes

Assignees
No one assigned
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation rule Relates to ESLint's core rules
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Potentially incorrect documentation example for no-return-await
3 participants
@mdjermanovic @btmills @anikethsaha