From 1a2bb7f5e61f31f2bc2bb1025663562f09edf6da Mon Sep 17 00:00:00 2001 From: Brett Zamir Date: Sun, 29 Dec 2019 21:35:57 +0800 Subject: [PATCH] docs(`implements-on-classes`): indicate that non-constructors can use `@type` instead to refer to a callback --- .README/rules/implements-on-classes.md | 4 ++++ README.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/.README/rules/implements-on-classes.md b/.README/rules/implements-on-classes.md index 5b71fc3df..c35414af4 100644 --- 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 index 2beb3152b..bb3d86c99 100644 --- 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`|