docs(implements-on-classes): indicate that non-constructors can use…

… `@type` instead to refer to a callback
gajus · Dec 29, 2019 · 1a2bb7f · 1a2bb7f
1 parent 5b8a413
commit 1a2bb7f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/.README/rules/implements-on-classes.md b/.README/rules/implements-on-classes.md
@@ -5,6 +5,10 @@ Reports an issue with any non-constructor function using `@implements`.
 Constructor functions, whether marked with `@class`, `@constructs`, or being
 an ES6 class constructor, will not be flagged.
 
+To indicate that a function follows another function's signature, one might
+instead use `@type` to indicate the `@function` or `@callback` to which the
+funciton is adhering.
+
 |||
 |---|---|
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|

diff --git a/README.md b/README.md
@@ -3728,6 +3728,10 @@ Reports an issue with any non-constructor function using `@implements`.
 Constructor functions, whether marked with `@class`, `@constructs`, or being
 an ES6 class constructor, will not be flagged.
 
+To indicate that a function follows another function's signature, one might
+instead use `@type` to indicate the `@function` or `@callback` to which the
+funciton is adhering.
+
 |||
 |---|---|
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|