From ae7e10675a0324d26a4cf1229ebb07e0214cd87b Mon Sep 17 00:00:00 2001
From: Yoriyasu Yano <430092+yorinasub17@users.noreply.github.com>
Date: Wed, 18 Oct 2023 09:28:49 -0500
Subject: [PATCH] chore: Update runRule comment to include the additional
 parameters of the function

Signed-off-by: Yoriyasu Yano <430092+yorinasub17@users.noreply.github.com>
---
 src/engine/interpreter.ts | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/engine/interpreter.ts b/src/engine/interpreter.ts
index d3038c1..4df04da 100644
--- a/src/engine/interpreter.ts
+++ b/src/engine/interpreter.ts
@@ -89,6 +89,8 @@ export interface IRuleResult {
  * @param ruleFn A string containing the definition of a main function that takes in the patch object and returns a bool
  *               indicating if the patch passes the rule (and thus should allow auto-merge).
  * @param patch A list of patch objects to evaluate the rule against.
+ * @param changeSetMetadata Metadata about the change set that is useful for constructing approval rules.
+ * @param opts Optional parameters that configure the behavior of the rule engine.
  * @returns A boolean indicating whether the given patch passes the user defined rule.
  */
 export function runRule(