From 9b12fe818b421a74278e7c1c9a116229c79901c8 Mon Sep 17 00:00:00 2001
From: gtrepta <50716988+gtrepta@users.noreply.github.com>
Date: Thu, 21 Mar 2024 19:06:56 -0500
Subject: [PATCH] Add a comment to MinimizeTermConstruction describing what it
 does (#4124)

Fixes #4113

This just adds a small comment to describe what
`MinimizeTermConstruction` does as otherwise there's nothing that
explains what it's doing.

Co-authored-by: rv-jenkins <admin@runtimeverification.com>
---
 .../org/kframework/compile/MinimizeTermConstruction.java  | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/kernel/src/main/java/org/kframework/compile/MinimizeTermConstruction.java b/kernel/src/main/java/org/kframework/compile/MinimizeTermConstruction.java
index 8a94e94b415..512e92442f4 100644
--- a/kernel/src/main/java/org/kframework/compile/MinimizeTermConstruction.java
+++ b/kernel/src/main/java/org/kframework/compile/MinimizeTermConstruction.java
@@ -17,6 +17,14 @@
 import org.kframework.definition.Sentence;
 import org.kframework.kore.*;
 
+/**
+ * MinimizeTermConstruction.
+ *
+ * <p>Looks for places where #as patterns can be used to reduce the number of constructors in
+ * rewrites:
+ *
+ * <p>`P1 => P2[P1]` -> `P1 #as X => P2[X]`
+ */
 public class MinimizeTermConstruction {
 
   private final Set<KVariable> vars = new HashSet<>();