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.

Sign up for GitHub

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

Documentation Improvements #199

Closed
wants to merge 16 commits into from
Closed

Documentation Improvements #199

wants to merge 16 commits into from

Conversation

cherryblossom000
Copy link
Contributor

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • New rule
  • Changes an existing rule
  • Add autofixing to a rule
  • Other, please explain:

What changes did you make? (Give an overview)

Use the format outlined in #109 and add missing documentation.

Fixes #109
Fixes #118

@cherryblossom000 cherryblossom000 marked this pull request as ready for review July 18, 2020 07:44
cherryblossom000
cherryblossom000 commented Jul 18, 2020
View reviewed changes
docs/rules/no-promise-in-callback.md
Comment on lines +7 to +8
Promises and callbacks are different ways to handle asynchronous code and should
not be mixed.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I know this is not a very good explanation — what should I put here instead?

@cherryblossom000
docs(always-return): use new format, add explanation
f6a2e31
@cherryblossom000
docs(avoid-new): add explanation and examples
d26e45d
@cherryblossom000
docs(catch-or-return): use new format, add more explanations and exam…
8b444f7 
…ples
@cherryblossom000
docs(no-native): use new format and add more explanation
16aed37
@cherryblossom000
docs(no-nesting): use new format
614bc1a
@cherryblossom000
docs(no-new-statics): fix grammar
8833987
@cherryblossom000
docs(no-nesting): add rule details
8c4df3e
@cherryblossom000
docs(always-return): use single quotes in code examples
a358f1f
@cherryblossom000
docs(no-return-in-finally): use new format
b11e41b
@cherryblossom000
docs(no-return-wrap): use new format
7ce2014
@cherryblossom000
docs(param-names): use new format
1a44987
@cherryblossom000
docs(no-new-statics): add part about using using with a type checker
7bca9fc
@cherryblossom000
docs(valid-params): mention typescript
de9180b
@cherryblossom000
docs(prefer-await-to-callbacks): add documentation
8071392
@cherryblossom000
docs(prefer-await-to-then): use new format
00e6d0b 
# Conflicts:
#	docs/rules/prefer-await-to-then.md
@cherryblossom000
docs(no-promise-in-callback): add documentation
88ef120
This was referenced Jul 20, 2024
Merged
Merged
ota-meshi pushed a commit that referenced this pull request Jul 24, 2024
@brettz9
docs: supply missing docs (#503)
602d825 
**What is the purpose of this pull request?**

- [x] Documentation update

**What changes did you make? (Give an overview)**

Supply missing doc pages. Draws heavily again from #199.

Also:
- uses latest Node URLs

Fixes #214.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve documentation Missing docs for prefer-await-to-callback
1 participant
@cherryblossom000