From 947b72eb0fc8b0b3ea163110d1e8fb9d5b1c2d80 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jos=C3=A9=20Valim?= <jose.valim@dashbit.co>
Date: Fri, 7 Jul 2023 11:57:20 +0200
Subject: [PATCH] Clarify log levels

---
 lib/logger_backends.ex | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/lib/logger_backends.ex b/lib/logger_backends.ex
index 3777e28..2bf8b13 100644
--- 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 """