From 1d8c666e5de19880b789709c322ae5658f618623 Mon Sep 17 00:00:00 2001
From: oflatt <oflatt@gmail.com>
Date: Tue, 6 Aug 2024 11:58:24 -0600
Subject: [PATCH] better docs

---
 src/ast/mod.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/ast/mod.rs b/src/ast/mod.rs
index 4303e1ea1..04ec50c74 100644
--- a/src/ast/mod.rs
+++ b/src/ast/mod.rs
@@ -48,7 +48,12 @@ impl Display for Id {
 #[derive(Clone, Debug)]
 /// The egglog internal representation of already compiled rules
 pub(crate) enum Ruleset {
+    /// Represents a ruleset with a set of rules.
+    /// Use an [`IndexMap`] to ensure egglog is deterministic.
+    /// Rules added to the [`IndexMap`] first apply their
+    /// actions first.
     Rules(Symbol, IndexMap<Symbol, CompiledRule>),
+    /// A combined ruleset may contain other rulesets.
     Combined(Symbol, Vec<Symbol>),
 }