From 40390d1adacda812a1a3f87b2a5fc727c4c1d8c1 Mon Sep 17 00:00:00 2001
From: Tom Hvitved <hvitved@github.com>
Date: Tue, 22 Apr 2025 15:08:39 +0200
Subject: [PATCH] Address review comment

---
 ql/ql/src/codeql_ql/ast/Yaml.qll | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/ql/ql/src/codeql_ql/ast/Yaml.qll b/ql/ql/src/codeql_ql/ast/Yaml.qll
index 403640c1f84..e88f2a0c2aa 100644
--- a/ql/ql/src/codeql_ql/ast/Yaml.qll
+++ b/ql/ql/src/codeql_ql/ast/Yaml.qll
@@ -88,6 +88,16 @@ class QlPackDocument extends YamlDocument {
   }
 }
 
+/**
+ * Holds if `qlref` is a `.qlref` YAML document referencing a query
+ * at relative path `relativePath`, and `f` is a candidate folder
+ * in which to lookup the referenced query.
+ *
+ * `f` is either:
+ * - the root of the QL pack containing `qlref`,
+ * - the root of a QL pack that is a dependency of the QL pack containing `qlref`, or
+ * - the folder containing `qlref`.
+ */
 private predicate shouldAppend(QlRefDocument qlref, Folder f, string relativePath) {
   relativePath = qlref.getRelativeQueryPath() and
   (