Skip to content

Commit b396832

Browse files
committed
docs(match-description): add alias desc to separate column
1 parent 4d5400f commit b396832

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

.README/rules/match-description.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,8 @@ Overrides the default contexts (see below).
9393
|||
9494
|---|---|
9595
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
96-
|Tags|docblock and `@description` (or `@desc`) by default but more with `tags`|
96+
|Tags|docblock and `@description` by default but more with `tags`|
97+
|Aliases|`@desc`|
9798
|Settings||
9899
|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`|
99100

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2582,7 +2582,8 @@ Overrides the default contexts (see below).
25822582
|||
25832583
|---|---|
25842584
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
2585-
|Tags|docblock and `@description` (or `@desc`) by default but more with `tags`|
2585+
|Tags|docblock and `@description` by default but more with `tags`|
2586+
|Aliases|`@desc`|
25862587
|Settings||
25872588
|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`|
25882589

0 commit comments

Comments
 (0)