Merge pull request #541 from Kraigie/state-machine-translator-should-…

…be-internal

Document StateMachineTranslator as internal

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).

mix.exs

@@ -100,8 +100,7 @@ defmodule Nostrum.Mixfile do
         ~r/Nostrum.Constants/
       ],
       Utilities: [
-        ~r/Nostrum.(Snowflake|Token|Util)/,
-        ~r/^Nostrum\.StateMachineTranslator$/
+        ~r/Nostrum.(Snowflake|Token|Util)/
       ],
       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