From 25f226e9dcde46757bccdb732318a03f8e353fd0 Mon Sep 17 00:00:00 2001
From: Tom Hvitved <hvitved@github.com>
Date: Mon, 17 May 2021 15:02:40 +0200
Subject: [PATCH] Add comment to `getVariableReal`

---
 ql/src/codeql_ruby/ast/internal/Variable.qll | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/ql/src/codeql_ruby/ast/internal/Variable.qll b/ql/src/codeql_ruby/ast/internal/Variable.qll
index 456286f20a2..21becb15cce 100644
--- a/ql/src/codeql_ruby/ast/internal/Variable.qll
+++ b/ql/src/codeql_ruby/ast/internal/Variable.qll
@@ -508,6 +508,11 @@ class TVariableAccessReal =
       TClassVariableAccess;
 
 abstract class VariableAccessReal extends VariableAccess, TVariableAccessReal {
+  /**
+   * Same as `getVariable()`, but restricted to non-synthesized variable accesses.
+   *
+   * The sole purpose of this predicate is to make AST synthesis monotonic.
+   */
   abstract VariableReal getVariableReal();
 }