Skip to content

Commit

Permalink
chore: Update runRule comment to include the additional parameters of…
Browse files Browse the repository at this point in the history
… the function

Signed-off-by: Yoriyasu Yano <430092+yorinasub17@users.noreply.github.com>
  • Loading branch information
yorinasub17 committed Oct 18, 2023
1 parent 3093c94 commit ae7e106
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/engine/interpreter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down

0 comments on commit ae7e106

Please sign in to comment.