From 474dc588dfeece919b122a004887ecba3196a9db Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
 <41898282+github-actions[bot]@users.noreply.github.com>
Date: Tue, 12 May 2026 18:58:21 +0000
Subject: [PATCH] docs: fix incorrect 'cyclomatic' label in
 UnifiedFunctionMetrics JSDoc

The extension calculates cognitive complexity (per SonarSource spec),
not cyclomatic complexity. The JSDoc comment on the `complexity` field
of `UnifiedFunctionMetrics` mistakenly said 'cyclomatic'.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
 src/metricsAnalyzer/metricsAnalyzerFactory.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/metricsAnalyzer/metricsAnalyzerFactory.ts b/src/metricsAnalyzer/metricsAnalyzerFactory.ts
index c91a8a8..2d4ab20 100644
--- a/src/metricsAnalyzer/metricsAnalyzerFactory.ts
+++ b/src/metricsAnalyzer/metricsAnalyzerFactory.ts
@@ -38,7 +38,7 @@ export interface UnifiedMetricsDetail {
 export interface UnifiedFunctionMetrics {
   /** The name or identifier of the function */
   name: string;
-  /** The total cyclomatic complexity score for this function */
+  /** The total cognitive complexity score for this function */
   complexity: number;
   /** Array of individual complexity details that contribute to the total score */
   details: UnifiedMetricsDetail[];