Document StateMachineTranslator as internal

Kraigie · Apr 19, 2024 · a580e6f · a580e6f
1 parent a82e9f4
commit a580e6f
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/lib/nostrum/state_machine_translator.ex b/lib/nostrum/state_machine_translator.ex
@@ -2,6 +2,13 @@ defmodule Nostrum.StateMachineTranslator do
   @moduledoc """
   Translate error reports for `:gen_statem` modules in Elixir.
 
+  > ### Internal module {: .info}
+  >
+  > This module is intended for exclusive usage inside of nostrum, and is
+  > documented for completeness and people curious to look behind the covers.
+
+  ## Reasoning
+
   By default, Elixir will ignore these messages altogether, see [this
   ElixirForum
   post](https://elixirforum.com/t/why-does-logger-translator-ignore-gen-statem-reports/37418).

diff --git a/mix.exs b/mix.exs
@@ -101,7 +101,6 @@ defmodule Nostrum.Mixfile do
       ],
       Utilities: [
         ~r/Nostrum.(Snowflake|Token|Util)/,
-        ~r/^Nostrum\.StateMachineTranslator$/
       ],
       Stores: [
         ~r/Nostrum.Store.\w+$/
@@ -112,7 +111,8 @@ defmodule Nostrum.Mixfile do
       ],
       "Internal modules": [
         ~r/Nostrum.Api.Ratelimiter/,
-        ~r/Nostrum.Shard/
+        ~r/Nostrum.Shard/,
+        ~r/^Nostrum\.StateMachineTranslator$/,
       ]
     ]
   end