Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Document StateMachineTranslator as internal #541

Merged
merged 1 commit into from
Apr 19, 2024
Merged

Document StateMachineTranslator as internal #541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions lib/nostrum/state_machine_translator.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
6 changes: 3 additions & 3 deletions mix.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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+$/
Expand All @@ -112,7 +111,8 @@ defmodule Nostrum.Mixfile do
],
"Internal modules": [
~r/Nostrum.Api.Ratelimiter/,
~r/Nostrum.Shard/
~r/Nostrum.Shard/,
~r/^Nostrum\.StateMachineTranslator$/
]
]
end
Expand Down
Loading