Skip to content

Commit ad97ccd

Browse files
committed
docs: update
1 parent 7b0740d commit ad97ccd

File tree

3 files changed

+4
-2
lines changed

3 files changed

+4
-2
lines changed

.README/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,7 @@ Finally, enable all of the rules that you would like to use.
278278
"jsdoc/sort-tags": 1,
279279
"jsdoc/tag-lines": 1, // Recommended
280280
"jsdoc/text-escaping": 1,
281+
"jsdoc/ts-prefer-function-type": 1,
281282
"jsdoc/ts-method-signature-style": 1,
282283
"jsdoc/type-formatting": 1,
283284
"jsdoc/valid-types": 1 // Recommended

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,7 @@ Finally, enable all of the rules that you would like to use.
305305
"jsdoc/sort-tags": 1,
306306
"jsdoc/tag-lines": 1, // Recommended
307307
"jsdoc/text-escaping": 1,
308+
"jsdoc/ts-prefer-function-type": 1,
308309
"jsdoc/ts-method-signature-style": 1,
309310
"jsdoc/type-formatting": 1,
310311
"jsdoc/valid-types": 1 // Recommended
@@ -499,6 +500,6 @@ non-default-recommended fixer).
499500
|:heavy_check_mark:|:wrench:| [tag-lines](./docs/rules/tag-lines.md#readme) | Enforces lines (or no lines) before, after, or between tags. |
500501
||:wrench:| [text-escaping](./docs/rules/text-escaping.md#readme) | Auto-escape certain characters that are input within block and tag descriptions. |
501502
||:wrench:| [ts-method-signature-style](./docs/rules/ts-method-signature-style.md#readme) | Prefers either function properties or method signatures |
502-
||:wrench:| [ts-prefer-function-type](./docs/rules/ts-prefer-function-type.md#readme) | |
503+
||:wrench:| [ts-prefer-function-type](./docs/rules/ts-prefer-function-type.md#readme) | Prefers function types over call signatures when there are no other properties. |
503504
||:wrench:| [type-formatting](./docs/rules/type-formatting.md#readme) | Formats JSDoc type values. |
504505
|:heavy_check_mark:|| [valid-types](./docs/rules/valid-types.md#readme) | Requires all types/namepaths to be valid JSDoc, Closure compiler, or TypeScript types (configurable in settings). |

src/rules.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2952,7 +2952,7 @@ export interface Rules {
29522952
}
29532953
];
29542954

2955-
/** */
2955+
/** Prefers function types over call signatures when there are no other properties. */
29562956
"jsdoc/ts-prefer-function-type":
29572957
| []
29582958
| [

0 commit comments

Comments
 (0)