From c89f651596bb98280ca44206781732b23da32557 Mon Sep 17 00:00:00 2001
From: Zach Daniel <zach@zachdaniel.dev>
Date: Fri, 15 Sep 2023 09:40:28 -0400
Subject: [PATCH] docs: clean up module documentation setup

---
 lib/builtin_changes/builtin_changes.ex        |  2 +-
 lib/builtin_changes/next_state.ex             |  5 +----
 lib/builtin_changes/transition_state.ex       |  4 +---
 lib/transformers/add_state.ex                 |  3 ++-
 lib/transformers/ensure_state_selected.ex     |  3 ++-
 lib/transformers/fill_in_event_defaults.ex    |  2 +-
 lib/verifiers/verify_default_initial_state.ex |  3 ++-
 lib/verifiers/verify_transition_actions.ex    |  3 ++-
 mix.exs                                       | 10 ++++++++++
 9 files changed, 22 insertions(+), 13 deletions(-)

diff --git a/lib/builtin_changes/builtin_changes.ex b/lib/builtin_changes/builtin_changes.ex
index 3603985..8963019 100644
--- a/lib/builtin_changes/builtin_changes.ex
+++ b/lib/builtin_changes/builtin_changes.ex
@@ -11,7 +11,7 @@ defmodule AshStateMachine.BuiltinChanges do
   end
 
   @doc """
-  Try and transition to the next state.
+  Try and transition to the next state. Must be only one possible next state.
   """
   def next_state, do: AshStateMachine.BuiltinChanges.NextState
 end
diff --git a/lib/builtin_changes/next_state.ex b/lib/builtin_changes/next_state.ex
index 33101a0..86ca45d 100644
--- a/lib/builtin_changes/next_state.ex
+++ b/lib/builtin_changes/next_state.ex
@@ -1,8 +1,5 @@
 defmodule AshStateMachine.BuiltinChanges.NextState do
-  @moduledoc """
-  Given the action and the current state, attempt to find the next state to
-  transition into.
-  """
+  @moduledoc false
   use Ash.Resource.Change
 
   def change(changeset, _opts, _) do
diff --git a/lib/builtin_changes/transition_state.ex b/lib/builtin_changes/transition_state.ex
index fb78daf..1ff07fb 100644
--- a/lib/builtin_changes/transition_state.ex
+++ b/lib/builtin_changes/transition_state.ex
@@ -1,7 +1,5 @@
 defmodule AshStateMachine.BuiltinChanges.TransitionState do
-  @moduledoc """
-  Transitions the state to a new state, validating the transition.
-  """
+  @moduledoc false
   use Ash.Resource.Change
 
   def change(changeset, opts, _) do
diff --git a/lib/transformers/add_state.ex b/lib/transformers/add_state.ex
index dd25e7b..2176e02 100644
--- a/lib/transformers/add_state.ex
+++ b/lib/transformers/add_state.ex
@@ -1,5 +1,6 @@
 defmodule AshStateMachine.Transformers.AddState do
-  @moduledoc "Adds or enforces details about the state attribute"
+  # Adds or enforces details about the state attribute
+  @moduledoc false
   use Spark.Dsl.Transformer
   alias Spark.Dsl.Transformer
 
diff --git a/lib/transformers/ensure_state_selected.ex b/lib/transformers/ensure_state_selected.ex
index aa9c005..3b6da7f 100644
--- a/lib/transformers/ensure_state_selected.ex
+++ b/lib/transformers/ensure_state_selected.ex
@@ -1,5 +1,6 @@
 defmodule AshStateMachine.Transformers.EnsureStateSelected do
-  @moduledoc "Ensures that `state` is always selected on queries."
+  #Ensures that `state` is always selected on queries.
+  @moduledoc false
   use Spark.Dsl.Transformer
 
   def transform(dsl_state) do
diff --git a/lib/transformers/fill_in_event_defaults.ex b/lib/transformers/fill_in_event_defaults.ex
index 9ca225f..d0ff593 100644
--- a/lib/transformers/fill_in_event_defaults.ex
+++ b/lib/transformers/fill_in_event_defaults.ex
@@ -1,7 +1,7 @@
 defmodule AshStateMachine.Transformers.FillInTransitionDefaults do
+  @moduledoc false
   use Spark.Dsl.Transformer
   alias Spark.Dsl.Transformer
-  @moduledoc false
 
   def transform(dsl_state) do
     initial_states = AshStateMachine.Info.state_machine_initial_states!(dsl_state)
diff --git a/lib/verifiers/verify_default_initial_state.ex b/lib/verifiers/verify_default_initial_state.ex
index 3bd77fc..b934049 100644
--- a/lib/verifiers/verify_default_initial_state.ex
+++ b/lib/verifiers/verify_default_initial_state.ex
@@ -1,5 +1,6 @@
 defmodule AshStateMachine.Verifiers.VerifyDefaultInitialState do
-  @moduledoc "Verifies the default initial state is in the list of initial states."
+  #Verifies the default initial state is in the list of initial states.
+  @moduledoc false
   use Spark.Dsl.Verifier
 
   def verify(dsl_state) do
diff --git a/lib/verifiers/verify_transition_actions.ex b/lib/verifiers/verify_transition_actions.ex
index 39247ab..55a02f7 100644
--- a/lib/verifiers/verify_transition_actions.ex
+++ b/lib/verifiers/verify_transition_actions.ex
@@ -1,5 +1,6 @@
 defmodule AshStateMachine.Verifiers.VerifyTransitionActions do
-  @moduledoc "Verifies that each transition corresponds to an update action"
+  # Verifies that each transition corresponds to an update action
+  @moduledoc false
   use Spark.Dsl.Verifier
 
   def verify(dsl_state) do
diff --git a/mix.exs b/mix.exs
index 64b2e53..433e049 100644
--- a/mix.exs
+++ b/mix.exs
@@ -115,9 +115,19 @@ defmodule AshStateMachine.MixProject do
         Dsl: [
           AshStateMachine
         ],
+        Introspection: [
+          AshStateMachine.Info,
+          AshStateMachine.Transition
+        ],
+        Helpers: [
+          AshStateMachine.BuiltinChanges
+        ],
         Charts: [
           AshStateMachine.Charts
         ],
+        Errors: [
+          ~r/AshStateMachine.Errors/
+        ],
         Internals: ~r/.*/
       ]
     ]