-
-
Notifications
You must be signed in to change notification settings - Fork 160
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: rename rule as intended to
check-line-alignment
Also clean-up docs; remove examples from source (auto-generated from tests); rename rule to line-alignment
- Loading branch information
Showing
8 changed files
with
132 additions
and
155 deletions.
There are no files selected for viewing
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
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
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`| |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.