From c81376f1ddb4f6e314d5be7165a423359502a37b Mon Sep 17 00:00:00 2001 From: Eksperimental Date: Mon, 4 Aug 2025 09:57:56 -0500 Subject: [PATCH 1/2] Document :description field in CompileError --- lib/elixir/lib/exception.ex | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/elixir/lib/exception.ex b/lib/elixir/lib/exception.ex index b57fc3c293..0d679a34b4 100644 --- a/lib/elixir/lib/exception.ex +++ b/lib/elixir/lib/exception.ex @@ -1389,6 +1389,7 @@ defmodule CompileError do * `:file` (`t:Path.t/0` or `nil`) - the file where the error occurred, or `nil` if the error occurred in code that did not come from a file * `:line` (`t:non_neg_integer/0`) - the line where the error occurred + * `:description` - a description of the compile error This is mostly raised by Elixir tooling when compiling and evaluating code. """ From 37cd3a1f54140fe02d0ae914187a52198cde66df Mon Sep 17 00:00:00 2001 From: Eksperimental Date: Sat, 23 Aug 2025 07:00:07 -0500 Subject: [PATCH 2/2] Add type in parenthesis to `:description` field in `t:Exception.t/0` MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: José Valim --- lib/elixir/lib/exception.ex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/elixir/lib/exception.ex b/lib/elixir/lib/exception.ex index 0d679a34b4..5773b9fbbc 100644 --- a/lib/elixir/lib/exception.ex +++ b/lib/elixir/lib/exception.ex @@ -1389,7 +1389,7 @@ defmodule CompileError do * `:file` (`t:Path.t/0` or `nil`) - the file where the error occurred, or `nil` if the error occurred in code that did not come from a file * `:line` (`t:non_neg_integer/0`) - the line where the error occurred - * `:description` - a description of the compile error + * `:description` (`t:String.t/0`) - a description of the compile error This is mostly raised by Elixir tooling when compiling and evaluating code. """