Add/update some code comments

github · Jan 24, 2024 · 12449ad · 12449ad
1 parent 3d9a8d2
commit 12449ad
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/extensions/ql-vscode/src/variant-analysis/ql-pack-details.ts b/extensions/ql-vscode/src/variant-analysis/ql-pack-details.ts
@@ -5,14 +5,14 @@ import type { QueryLanguage } from "../common/query-language";
  * a variant analysis.
  */
 export interface QlPackDetails {
-  // The full paths of the query files.
+  // The absolute paths of the query files.
   queryFiles: string[];
 
-  // The path to the QL pack that is used for triggering a variant analysis.
+  // The absolute path to the QL pack that is used for triggering a variant analysis.
   // If there is no query pack, this is the same as the directory of the query files.
   qlPackRootPath: string;
 
-  // The path to the QL pack file (a qlpack.yml or codeql-pack.yml) or undefined if
+  // The absolute path to the QL pack file (a qlpack.yml or codeql-pack.yml) or undefined if
   // it doesn't exist.
   qlPackFilePath: string | undefined;
 

diff --git a/extensions/ql-vscode/src/variant-analysis/variant-analysis-manager.ts b/extensions/ql-vscode/src/variant-analysis/variant-analysis-manager.ts
@@ -380,6 +380,9 @@ export class VariantAnalysisManager
       this.dbManager,
     );
 
+    // For now we ge the metadata for the first query in the pack.
+    // and use that in the submission and query history. In the future
+    // we'll need to consider how to handle having multiple queries.
     const firstQueryFile = qlPackDetails.queryFiles[0];
     const queryMetadata = await tryGetQueryMetadata(
       this.cliServer,