From f62f51a1610280660ca1ff30c857396dc9693f8d Mon Sep 17 00:00:00 2001 From: Brett Zamir Date: Sat, 11 Feb 2023 07:43:27 -0700 Subject: [PATCH] docs: fix `postHyphens` -> `postHyphen`; fixes #984 --- .README/rules/check-line-alignment.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.README/rules/check-line-alignment.md b/.README/rules/check-line-alignment.md index 657e4a8d6..6757f2a36 100644 --- a/.README/rules/check-line-alignment.md +++ b/.README/rules/check-line-alignment.md @@ -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. diff --git a/README.md b/README.md index 0abc9fe2e..2631b212e 100644 --- a/README.md +++ b/README.md @@ -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.