Skip to content

Document :description field in CompileError #14692

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 23, 2025
+1 −0
Merged

Document :description field in CompileError #14692

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c81376f
Document :description field in CompileError
eksperimental Aug 4, 2025
37cd3a1
Add type in parenthesis to `:description` field in `t:Exception.t/0`
eksperimental Aug 23, 2025
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
1 change: 1 addition & 0 deletions lib/elixir/lib/exception.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` (`t:String.t/0`) - a description of the compile error

This is mostly raised by Elixir tooling when compiling and evaluating code.
"""
Expand Down