diff options
| author | ST-DDT <[email protected]> | 2024-09-10 00:56:58 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-09-09 22:56:58 +0000 |
| commit | acb8b5258fa645e499831fca43b319b0439c0baf (patch) | |
| tree | 249085a072923558c7cacc9a276c16a11697f617 /scripts/apidocs/processing/jsdocs.ts | |
| parent | f128d77194003192d27a3eb897f4a7ad02980ed0 (diff) | |
| download | faker-acb8b5258fa645e499831fca43b319b0439c0baf.tar.xz faker-acb8b5258fa645e499831fca43b319b0439c0baf.zip | |
infra: improve error messages for parameter properties (#3082)
Diffstat (limited to 'scripts/apidocs/processing/jsdocs.ts')
| -rw-r--r-- | scripts/apidocs/processing/jsdocs.ts | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/scripts/apidocs/processing/jsdocs.ts b/scripts/apidocs/processing/jsdocs.ts index 4135e5e6..0999abca 100644 --- a/scripts/apidocs/processing/jsdocs.ts +++ b/scripts/apidocs/processing/jsdocs.ts @@ -10,7 +10,11 @@ import { export type JSDocableLikeNode = Pick<JSDocableNode, 'getJsDocs'>; export function getJsDocs(node: JSDocableLikeNode): JSDoc { - return exactlyOne(node.getJsDocs(), 'jsdocs'); + return exactlyOne( + node.getJsDocs(), + 'jsdocs', + 'Please ensure that each method signature has JSDocs, and that all properties of option/object parameters are documented with both @param tags and inline JSDocs.' + ); } export function getDeprecated(jsdocs: JSDoc): string | undefined { |