docs(match-description): add alias desc to separate column

gajus · Jul 14, 2019 · b396832 · b396832
1 parent 4d5400f
commit b396832
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/.README/rules/match-description.md b/.README/rules/match-description.md
@@ -93,7 +93,8 @@ Overrides the default contexts (see below).
 |||
 |---|---|
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
-|Tags|docblock and `@description` (or `@desc`) by default but more with `tags`|
+|Tags|docblock and `@description` by default but more with `tags`|
+|Aliases|`@desc`|
 |Settings||
 |Options|`contexts`, `tags` (accepts tags with names and optional type such as 'param', 'arg', 'argument', 'property', and 'prop', and accepts arbitrary list of other tags with an optional type (but without names), e.g., 'returns', 'return'), `mainDescription`, `matchDescription`|
 

diff --git a/README.md b/README.md
@@ -2582,7 +2582,8 @@ Overrides the default contexts (see below).
 |||
 |---|---|
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
-|Tags|docblock and `@description` (or `@desc`) by default but more with `tags`|
+|Tags|docblock and `@description` by default but more with `tags`|
+|Aliases|`@desc`|
 |Settings||
 |Options|`contexts`, `tags` (accepts tags with names and optional type such as 'param', 'arg', 'argument', 'property', and 'prop', and accepts arbitrary list of other tags with an optional type (but without names), e.g., 'returns', 'return'), `mainDescription`, `matchDescription`|