Recode
v0.6.5

View Source Recode.Issue (Recode v0.6.5)

An Issue struct to track findings by the chechers.

Summary

Types

t()

Functions

new(reporter, message, info \\ [], meta \\ nil)

Creates a new %Issue{}

Types

Link to this type

t()

View Source 
@type t() :: %Recode.Issue{
  column: non_neg_integer() | nil,
  line: non_neg_integer() | nil,
  message: String.t() | nil,
  meta: term(),
  reporter: module()
}

Functions

Link to this function

new(reporter, message, info \\ [], meta \\ nil)

View Source 
@spec new(module(), String.t() | term() | nil, keyword(), term()) :: t()

Creates a new %Issue{}

Examples 

iex> Recode.Issue.new(Test, "kaput", line: 1, column: 1)
%Recode.Issue{reporter: Test, message: "kaput", line: 1, column: 1, meta: nil}

iex> Recode.Issue.new(Test, foo: "bar")
%Recode.Issue{reporter: Test, message: nil, line: nil, column: nil, meta: [foo: "bar"]}