From e735e7a4e3246d38140c5356d69fb688f9817608 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Fri, 8 May 2026 01:54:12 +0200 Subject: [PATCH] fix(sandcastle): add missing JSDoc descriptions to satisfy lint rules --- .sandcastle/refinement-loop.ts | 6 +++--- .sandcastle/strategies/implement/strategy.ts | 4 ++-- .sandcastle/task-source.ts | 8 ++++---- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.sandcastle/refinement-loop.ts b/.sandcastle/refinement-loop.ts index 98c6fea3..b29e63d7 100644 --- a/.sandcastle/refinement-loop.ts +++ b/.sandcastle/refinement-loop.ts @@ -239,9 +239,9 @@ export async function runRefinementLoop ( } /** - * - * @param result - * @param round + * @param result - The round execution result. + * @param round - 1-indexed round number. + * @returns A snapshot for the round history. */ function buildRoundSnapshot (result: RoundResult, round: number): RoundSnapshot { return { diff --git a/.sandcastle/strategies/implement/strategy.ts b/.sandcastle/strategies/implement/strategy.ts index 3d1fbecd..99b68054 100644 --- a/.sandcastle/strategies/implement/strategy.ts +++ b/.sandcastle/strategies/implement/strategy.ts @@ -6,8 +6,8 @@ import { execFileAsync, toErrorMessage } from '../../utils.js' import { runValidation } from '../../validation.js' /** - * - * @param spec + * @param spec - Task specification with optional plan metadata. + * @returns Formatted plan context string for the actor prompt, or empty if no context. */ function buildPlanContext (spec: TaskSpec): string { const parts: string[] = [] diff --git a/.sandcastle/task-source.ts b/.sandcastle/task-source.ts index 83313095..a17dbb43 100644 --- a/.sandcastle/task-source.ts +++ b/.sandcastle/task-source.ts @@ -300,16 +300,16 @@ const VALID_CONFIDENCE = new Set(['high', 'low', 'medium']) const VALID_ISSUE_TYPES = new Set(['bug-fix', 'feature', 'refactor']) /** - * - * @param value + * @param value - Value to check. + * @returns Whether value is a valid confidence level. */ function isValidConfidence (value: unknown): value is 'high' | 'low' | 'medium' { return typeof value === 'string' && VALID_CONFIDENCE.has(value) } /** - * - * @param value + * @param value - Value to check. + * @returns Whether value is a valid issue type. */ function isValidIssueType (value: unknown): value is 'bug-fix' | 'feature' | 'refactor' { return typeof value === 'string' && VALID_ISSUE_TYPES.has(value) -- 2.53.0