Current section
Files
Jump to
Current section
Files
lib/dialyxir/warnings/extra_range.ex
defmodule Dialyxir.Warnings.ExtraRange do
@moduledoc """
The @spec says the function returns more types than the function
actually returns.
## Example
defmodule Example do
@spec ok() :: :ok | :error
def ok() do
:ok
end
end
"""
@behaviour Dialyxir.Warning
@impl Dialyxir.Warning
@spec warning() :: :extra_range
def warning(), do: :extra_range
@impl Dialyxir.Warning
@spec format_short([String.t()]) :: String.t()
def format_short([_module, function | _]) do
"@spec for #{function} has more types than are returned by the function."
end
@impl Dialyxir.Warning
@spec format_long([String.t()]) :: String.t()
def format_long([module, function, arity, extra_ranges, signature_range]) do
pretty_module = Erlex.pretty_print(module)
pretty_extra = Erlex.pretty_print_type(extra_ranges)
pretty_signature = Erlex.pretty_print_type(signature_range)
"""
The type specification has too many types for the function.
Function:
#{pretty_module}.#{function}/#{arity}
Extra type:
#{pretty_extra}
Success typing:
#{pretty_signature}
"""
end
@impl Dialyxir.Warning
@spec explain() :: String.t()
def explain() do
@moduledoc
end
end