Skip to content

Commit

Permalink
docs(newline-after-description): option explanation inverted; fixes #…
Browse files Browse the repository at this point in the history
  • Loading branch information
brettz9 committed Oct 11, 2019
1 parent 6985ce5 commit eb8edca
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .README/rules/newline-after-description.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Enforces a consistent padding of the block description.

#### Options

This rule allows one optional string argument. If it is `"always"` then a problem is raised when there is a newline after the description. If it is `"never"` then a problem is raised when there is no newline after the description. The default value is `"always"`.
This rule allows one optional string argument. If it is `"always"` then a problem is raised when there is no newline after the description. If it is `"never"` then a problem is raised when there is a newline after the description. The default value is `"always"`.

|||
|---|---|
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3396,7 +3396,7 @@ Enforces a consistent padding of the block description.
<a name="eslint-plugin-jsdoc-rules-newline-after-description-options-5"></a>
#### Options

This rule allows one optional string argument. If it is `"always"` then a problem is raised when there is a newline after the description. If it is `"never"` then a problem is raised when there is no newline after the description. The default value is `"always"`.
This rule allows one optional string argument. If it is `"always"` then a problem is raised when there is no newline after the description. If it is `"never"` then a problem is raised when there is a newline after the description. The default value is `"always"`.

|||
|---|---|
Expand Down

0 comments on commit eb8edca

Please sign in to comment.