docs(require-returns, require-returns-check): indicate that these wil…

…l report if multiple `returns` tags are present
brettz9 · Jul 13, 2019 · e52d763 · e52d763
1 parent 4b97157
commit e52d763
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/.README/rules/require-returns-check.md b/.README/rules/require-returns-check.md
@@ -2,6 +2,8 @@
 
 Checks if the return expression exists in function body and in the comment.
 
+Will also report if multiple `@returns` tags are present.
+
 |||
 |---|---|
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|

diff --git a/.README/rules/require-returns.md b/.README/rules/require-returns.md
@@ -2,6 +2,8 @@
 
 Requires returns are documented.
 
+Will also report if multiple `@returns` tags are present.
+
 #### Options
 
 - `exemptedBy` - Array of tags (e.g., `['type']`) whose presence on the document