docs(eslint-plugin): Improve ban-types description #773
Conversation
This file contains hidden or 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
Contributor
|
Thanks for the PR, @glenwinters! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint |
Member
|
you also need to change the description in the rule's source file. |
bradzacher
added
the
documentation
Codecov Report
@@ Coverage Diff @@
## master #773 +/- ##
======================================
Coverage 94.2% 94.2%
======================================
Files 112 112
Lines 4801 4801
Branches 1334 1334
======================================
Hits 4523 4523
Misses 159 159
Partials 119 119
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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 PR improves the description of the
ban-typesrule ineslint-plugin.Initially, I was going to fix the grammar of
Enforces that types will not to be used, but I found the description in the rule docs file to be better, especially considering the rule name.