Unity.Error (Unity v0.7.0)

Copy Markdown View Source

User-friendly error formatting for parse errors, evaluation errors, and unknown unit suggestions.

All errors are returned as plain strings suitable for terminal display.

Summary

Functions

format(message)

Formats an error for display to the user.

Functions

format(message)

@spec format({:error, String.t()} | String.t()) :: String.t()

Formats an error for display to the user.

Arguments

  • error - an error tuple or string.

Returns

A formatted error string prefixed with **.

Examples

iex> Unity.Error.format({:error, "unknown unit: \"frobnicator\""})
"** Unknown unit: \"frobnicator\""