From 420c97eadde1b53f6fb590ecf837b21d11a01cd8 Mon Sep 17 00:00:00 2001
From: Mario Campos <mario-campos@github.com>
Date: Fri, 19 Jun 2026 14:12:27 -0500
Subject: [PATCH] Improve documentation for cache file and command keys in CLI

---
 src/cache.ts  | 12 +++++-------
 src/codeql.ts |  2 ++
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/cache.ts b/src/cache.ts
index f14583a98..c094bf17b 100644
--- a/src/cache.ts
+++ b/src/cache.ts
@@ -4,15 +4,13 @@ import * as path from "path";
 import { getTemporaryDirectory } from "./actions-util";
 import * as json from "./json";
 
-/** The name of the temporary file backing the cache (tier 2). */
+/**
+ * The name of the temporary file that backs the on-disk cache of
+ * CLI responses between workflow steps.
+ */
 const COMMAND_CACHE_FILENAME = "codeql-action-command-cache.json";
 
-/**
- * The keys under which the output of cached `codeql` commands is stored. Each
- * key is shared by the producer (the corresponding method in `codeql.ts`) and
- * any consumers (e.g. `status-report.ts`, which peeks the cached version
- * without invoking the CLI).
- */
+/** The keys for cached CLI commands. */
 export enum CommandCacheKey {
   Version = "version",
   ResolveLanguages = "resolveLanguages",
diff --git a/src/codeql.ts b/src/codeql.ts
index c7c0b4e9d..6ade356e0 100644
--- a/src/codeql.ts
+++ b/src/codeql.ts
@@ -234,6 +234,7 @@ export interface VersionInfo {
   overlayVersion?: number;
 }
 
+/** Returns true if `x` is a {@link VersionInfo}. */
 export function isVersionInfo(x: unknown): x is VersionInfo {
   return (
     json.isObject(x) &&
@@ -264,6 +265,7 @@ export interface ResolveLanguagesOutput {
   };
 }
 
+/** Returns true if `x` is a {@link ResolveLanguagesOutput}. */
 export function isResolveLanguagesOutput(
   x: unknown,
 ): x is ResolveLanguagesOutput {