Describe desired behavior

pitch-io · Dec 14, 2023 · 790267f · 790267f
1 parent e859bcc
commit 790267f
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/src/moira/transition.cljs b/src/moira/transition.cljs
@@ -41,8 +41,11 @@
   The order of execution is determined by the dependency graph, so each module
   is guaranteed to be inserted after its dependencies.
 
-  If the `include-deps?` option is enabled, the queue will include missing
-  dependencies. The `reverse?` option inverts execution order."
+  `:include-deps?` can be set to `:out`, `:in`, or `:all`. `:out` adds missing
+  module dependencies, while `:in` includes modules that themselves depend on
+  any of the targeted modules. `:all` enables both directions.
+
+  The `:reverse?` option inverts execution order."
 
   [ks & {:keys [include-deps? reverse?]}]