From 121049c9f3ddaa4e1ecb9fef3e2971a246cc460d Mon Sep 17 00:00:00 2001
From: Johannes Christ <jc@jchri.st>
Date: Fri, 19 Apr 2024 13:35:02 +0200
Subject: [PATCH] Document StateMachineTranslator as internal

---
 lib/nostrum/state_machine_translator.ex | 7 +++++++
 mix.exs                                 | 6 +++---
 2 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/lib/nostrum/state_machine_translator.ex b/lib/nostrum/state_machine_translator.ex
index 7b9fc08b5..eeb9f5fe7 100644
--- 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
index d4284edbd..c18b8232c 100644
--- a/mix.exs
+++ b/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