Gcode.Model.Describe protocol (gcode v1.0.2)

Copy Markdown

A protocol which is used to describe the model for human consumption.

Summary

Types

t()

All the types that implement this protocol.

Functions

describe(describable)
describe(describable, opts)

Types

t()

@type t() :: term()

All the types that implement this protocol.

Functions

describe(describable)

@spec describe(t()) :: Gcode.Option.t(String.t())

describe(describable, opts)

@spec describe(t(), options :: []) :: Gcode.Option.t(String.t())