Packages

dialyxir

1.4.2
1.4.7 1.4.6 1.4.5 1.4.4 1.4.3 1.4.2 1.4.1 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 1.0.0-rc.7 1.0.0-rc.6 1.0.0-rc.5 1.0.0-rc.4 1.0.0-rc.3 1.0.0-rc.2 1.0.0-rc.1 1.0.0-rc.0 0.5.1 0.5.0 0.4.4 0.4.3 0.4.2 0.4.1 0.4.0 0.3.5 0.3.4 0.3.3 0.3.2 0.3.1 0.3.0 0.2.9 0.2.8

Mix tasks to simplify use of Dialyzer in Elixir projects.

HexDocs

Current section

Files

Jump to
Readme
35 Versions
1 Dependency
Dependants
Files
Activity
dialyxir lib dialyxir warnings unused_function.ex
Raw

lib/dialyxir/warnings/unused_function.ex 

defmodule Dialyxir.Warnings.UnusedFunction do

  @moduledoc """

  Due to issues higher in the function or call stack, while the

  function is recognized as used by the compiler, it will never be

  recognized as having been called until the other error is resolved.



  ## Example



      defmodule Example do

        def ok() do

          raise "error"



          unused()

        end



        defp unused(), do: :ok

      end

  """



  @behaviour Dialyxir.Warning



  @impl Dialyxir.Warning

  @spec warning() :: :unused_fun

  def warning(), do: :unused_fun



  @impl Dialyxir.Warning

  @spec format_short([String.t()]) :: String.t()

  def format_short(args), do: format_long(args)



  @impl Dialyxir.Warning

  @spec format_long([String.t()]) :: String.t()

  def format_long([function, arity]) do

    "Function #{function}/#{arity} will never be called."

  end



  @impl Dialyxir.Warning

  @spec explain() :: String.t()

  def explain() do

    @moduledoc

  end

end