Skip to content

Commit

Permalink
docs: fix postHyphens -> postHyphen; fixes #984
Browse files Browse the repository at this point in the history
  • Loading branch information
brettz9 committed Feb 11, 2023
1 parent 143d429 commit f62f51a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .README/rules/check-line-alignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ An object with any of the following keys set to an integer. Affects spacing:
- `postTag` - after the tag (e.g., `* @param `)
- `postType` - after the type (e.g., `* @param {someType} `)
- `postName` - after the name (e.g., `* @param {someType} name `)
- `postHyphens` - after any hyphens in the description (e.g., `* @param {someType} name - A description`)
- `postHyphen` - after any hyphens in the description (e.g., `* @param {someType} name - A description`)

If a spacing is not defined, it defaults to one.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2056,7 +2056,7 @@ An object with any of the following keys set to an integer. Affects spacing:
- `postTag` - after the tag (e.g., `* @param `)
- `postType` - after the type (e.g., `* @param {someType} `)
- `postName` - after the name (e.g., `* @param {someType} name `)
- `postHyphens` - after any hyphens in the description (e.g., `* @param {someType} name - A description`)
- `postHyphen` - after any hyphens in the description (e.g., `* @param {someType} name - A description`)

If a spacing is not defined, it defaults to one.

Expand Down

0 comments on commit f62f51a

Please sign in to comment.