From 06000781e945ede29ec545c71cd1729bcd771d0c Mon Sep 17 00:00:00 2001
From: Harry Maclean <harry@hmac.dev>
Date: Fri, 19 Nov 2021 14:54:06 +0000
Subject: [PATCH] Ruby: Document PairCfgNode::getKey/getValue

---
 ruby/ql/lib/codeql/ruby/controlflow/CfgNodes.qll | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/ruby/ql/lib/codeql/ruby/controlflow/CfgNodes.qll b/ruby/ql/lib/codeql/ruby/controlflow/CfgNodes.qll
index 097bd6979fb..cf4aa5921cf 100644
--- a/ruby/ql/lib/codeql/ruby/controlflow/CfgNodes.qll
+++ b/ruby/ql/lib/codeql/ruby/controlflow/CfgNodes.qll
@@ -440,8 +440,14 @@ module ExprNodes {
 
     final override Pair getExpr() { result = ExprCfgNode.super.getExpr() }
 
+    /**
+     * Gets the key expression of this pair.
+     */
     final ExprCfgNode getKey() { e.hasCfgChild(e.getKey(), this, result) }
 
+    /**
+     * Gets the value expression of this pair.
+     */
     final ExprCfgNode getValue() { e.hasCfgChild(e.getValue(), this, result) }
   }