radex v0.1.0 Radex.Writer.Example behaviour View Source

Behaviour for example writers

Link to this section Summary

Functions

examples(metadata)

Get examples for a map of metadata

use_example?(example)

Only use an example if there are 1 or more conns

Callbacks

write(metadata, path)

Link to this section Functions

Link to this function examples(metadata) View Source

examples(metadata :: map) :: [Radex.Metadata.t]

Get examples for a map of metadata

Link to this function use_example?(example) View Source

Only use an example if there are 1 or more conns

Link to this section Callbacks

Link to this callback write(metadata, path) View Source

write(metadata :: map, path :: Path.t) :: :ok