Clarify log levels

vkryukov · Jul 7, 2023 · 947b72e · 947b72e
1 parent 67e96e3
commit 947b72e
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/logger_backends.ex b/lib/logger_backends.ex
@@ -152,6 +152,12 @@ defmodule LoggerBackends do
   Check the `LoggerBackends.Console` implementation in Elixir's codebase
   for examples on how to handle the recommendations in this section and
   how to process the existing options.
+
+  ## Levels
+
+  For backwards compatibility purposes, a Logger Backend receives only `:debug`,
+  `:info`, `:warn`, and `:error` as log levels. In particular, notice you will
+  need to convert `:warn` to `:warning` if you plan to use the `Logger` functions.
   """
 
   @typedoc """