Skip to content

Commit e52d763

Browse files
committed
docs(require-returns, require-returns-check): indicate that these will report if multiple returns tags are present
1 parent 4b97157 commit e52d763

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

.README/rules/require-returns-check.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Checks if the return expression exists in function body and in the comment.
44

5+
Will also report if multiple `@returns` tags are present.
6+
57
|||
68
|---|---|
79
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|

.README/rules/require-returns.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Requires returns are documented.
44

5+
Will also report if multiple `@returns` tags are present.
6+
57
#### Options
68

79
- `exemptedBy` - Array of tags (e.g., `['type']`) whose presence on the document

0 commit comments

Comments
 (0)