Dialyxir.Warning behaviour (Dialyxir v1.4.2) View Source

Behaviour for defining warning semantics.

Contains callbacks for various warnings

Link to this section Summary

Callbacks

Explanation for a warning of this type. Should include a simple example of how to trigger it.

The default documentation when seeing an error without the user otherwise overriding the format.

A short message, often missing things like success types and expected types for space.

By expressing the warning that is to be matched on, error handling and dispatching can be avoided in format functions.

Link to this section Functions

Specs

default_explain() :: String.t()

Link to this section Callbacks

Specs

explain() :: String.t()

Explanation for a warning of this type. Should include a simple example of how to trigger it.

Specs

format_long([String.t()] | {String.t(), String.t(), String.t()} | String.t()) ::
  String.t()

The default documentation when seeing an error without the user otherwise overriding the format.

Specs

format_short([String.t()] | {String.t(), String.t(), String.t()} | String.t()) ::
  String.t()

A short message, often missing things like success types and expected types for space.

Specs

warning() :: atom()

By expressing the warning that is to be matched on, error handling and dispatching can be avoided in format functions.