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(eslint-plugin): rewrite member-ordering docs #349

Merged
merged 1 commit into from Mar 13, 2019

Conversation

Projects
None yet
2 participants
@timkraut
Copy link
Contributor

timkraut commented Mar 12, 2019

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).

@codecov

This comment has been minimized.

Copy link

codecov bot commented Mar 12, 2019

Codecov Report

Merging #349 into master will not change coverage.
The diff coverage is 100%.

@@           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
Impacted Files Coverage Δ
...ackages/eslint-plugin/src/rules/member-ordering.ts 96.72% <100%> (ø) ⬆️
@bradzacher
Copy link
Member

bradzacher left a comment

LGTM

@bradzacher bradzacher changed the title feat(eslint-plugin): rewrite member-ordering docs docs(eslint-plugin): rewrite member-ordering docs Mar 12, 2019

@timkraut timkraut force-pushed the timkraut:member-ordering-docs branch from 05b5de5 to 52b2efa Mar 13, 2019

@timkraut

This comment has been minimized.

Copy link
Contributor Author

timkraut commented Mar 13, 2019

I've found a tiny issue which I just fixed (the first code block should be ts not js).

@bradzacher bradzacher merged commit 3b28cac into typescript-eslint:master Mar 13, 2019

3 checks passed

Semantic Pull Request ready to be squashed
Details
codecov/patch 100% of diff hit (target 90%)
Details
codecov/project 97.24% (+0%) compared to 18484a2
Details

@timkraut timkraut deleted the timkraut:member-ordering-docs branch Mar 14, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.