Skip to content

Commit

Permalink
fix: rename rule as intended to check-line-alignment
Browse files Browse the repository at this point in the history
Also clean-up docs; remove examples from source (auto-generated from tests); rename rule to line-alignment
  • Loading branch information
brettz9 committed Sep 14, 2020
1 parent 6e2b99d commit ec71632
Show file tree
Hide file tree
Showing 8 changed files with 132 additions and 155 deletions.
1 change: 1 addition & 0 deletions .README/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,7 @@ selector).
{"gitdown": "include", "file": "./rules/check-alignment.md"}
{"gitdown": "include", "file": "./rules/check-examples.md"}
{"gitdown": "include", "file": "./rules/check-indentation.md"}
{"gitdown": "include", "file": "./rules/check-line-alignment.md"}
{"gitdown": "include", "file": "./rules/check-param-names.md"}
{"gitdown": "include", "file": "./rules/check-property-names.md"}
{"gitdown": "include", "file": "./rules/check-syntax.md"}
Expand Down
18 changes: 18 additions & 0 deletions .README/rules/check-line-alignment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### `check-line-alignment`

Reports invalid alignment of JSDoc block lines. This is a
[standard recommended to WordPress code](https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/#aligning-comments),
for example.

#### Options

This rule allows one optional string argument. If it is `"always"` then a
problem is raised when the lines are not aligned. If it is `"never"` then
a problem should be raised when there is more than one space between each
line's parts. **Only the non-default `"always"` is implemented for now.**

|||
|---|---|
|Context|everywhere|
|Options|(a string matching `"always"|"never"`)|
|Tags|`param`, `arg`, `argument`, `property`, `prop`|
64 changes: 0 additions & 64 deletions .README/rules/check-lines-alignment.md

This file was deleted.

Loading

0 comments on commit ec71632

Please sign in to comment.