From acb8b5258fa645e499831fca43b319b0439c0baf Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Tue, 10 Sep 2024 00:56:58 +0200 Subject: infra: improve error messages for parameter properties (#3082) --- scripts/apidocs/processing/jsdocs.ts | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'scripts/apidocs/processing/jsdocs.ts') 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; 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 { -- cgit v1.2.3