From 8151f3024d9ecaac18c4ddcc3407d04e760d8715 Mon Sep 17 00:00:00 2001
From: Geoffrey White <40627776+geoffw0@users.noreply.github.com>
Date: Thu, 29 Feb 2024 15:41:43 +0000
Subject: [PATCH] Shared: Pinch better doc for isEquality from a related Guards
 class in csharp.

---
 shared/rangeanalysis/codeql/rangeanalysis/RangeAnalysis.qll | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/shared/rangeanalysis/codeql/rangeanalysis/RangeAnalysis.qll b/shared/rangeanalysis/codeql/rangeanalysis/RangeAnalysis.qll
index 28329e844da..feff3010864 100644
--- a/shared/rangeanalysis/codeql/rangeanalysis/RangeAnalysis.qll
+++ b/shared/rangeanalysis/codeql/rangeanalysis/RangeAnalysis.qll
@@ -195,9 +195,9 @@ signature module Semantic {
     predicate directlyControls(BasicBlock controlled, boolean branch);
 
     /**
-     * Holds if the guard represents an equality between two expressions.
-     *
-     * @param e1 The first expression.
+     * Holds if this guard is an equality test between `e1` and `e2`. If the
+     * test is negated, that is `!=`, then `polarity` is false, otherwise
+     * `polarity` is true.
      */
     predicate isEquality(Expr e1, Expr e2, boolean polarity);