Dialyxir v1.0.0 Dialyxir.Warning behaviour 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 wihout 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 handlong and dispatching can be avoided in format functions

Link to this section Functions

Link to this function default_explain() View Source
default_explain() :: String.t()

Link to this section Callbacks

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

Link to this callback format_long(arg0) View Source
format_long([String.t()] | {String.t(), String.t(), String.t()} | String.t()) ::
  String.t()

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

Link to this callback format_short(arg0) View Source
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.

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