docs(eslint-plugin): rewrite member-ordering docs #349
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
Codecov Report
@@ Coverage Diff @@
## master #349 +/- ##
=======================================
Coverage 97.24% 97.24%
=======================================
Files 67 67
Lines 2357 2357
Branches 336 336
=======================================
Hits 2292 2292
Misses 44 44
Partials 21 21
|
bradzacher
changed the title
timkraut
force-pushed
the
member-ordering-docs
branch
from
05b5de5
to
52b2efa
Compare
|
I've found a tiny issue which I just fixed (the first code block should be |
bradzacher
approved these changes
Mar 13, 2019
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.
Part of the PR to enforce an alphabetic order for members is to rewrite the existing docs to better document the current behavior of
member-ordering. As this touches almost any line in the rule documentation, I thought it makes sense to open a separate PR for that.In this PR, I've reworked the entire rule documentation to make it (hopefully) more clear how this rule works. The examples are mostly taken from the current rule documentation - some with little adaptations.
Besides that, I've changed a few names and added some comments in the rule implementation to make it more understandable (basically the points I didn't understand immediately while trying to understand the current implementation to better describe the rule).