]> Piment Noir Git Repositories - e-mobility-charging-stations-simulator.git/commitdiff
fix(sandcastle): add missing JSDoc descriptions to satisfy lint rules
authorJérôme Benoit <jerome.benoit@sap.com>
Thu, 7 May 2026 23:54:12 +0000 (01:54 +0200)
committerJérôme Benoit <jerome.benoit@sap.com>
Thu, 7 May 2026 23:54:12 +0000 (01:54 +0200)
.sandcastle/refinement-loop.ts
.sandcastle/strategies/implement/strategy.ts
.sandcastle/task-source.ts

index 98c6fea3d550b01819d9d87707a2ce929119b657..b29e63d71ae7d0f63e48ed5c1725b4c0a3a3094b 100644 (file)
@@ -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 {
index 3d1fbecdb25e55ac2d0570f3693121edadefcc74..99b68054439c3987ec5c55bfd527d348e28a2f88 100644 (file)
@@ -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[] = []
index 8331309529abe2bf723ef24a55ec07984013a6e1..a17dbb4349993ac5267f34891474aa6d39a6ceff 100644 (file)
@@ -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)