ashton v0.4.1 Ashton.Doc View Source

Automatic opt documentation, to be placed into your function docstrings

Link to this section Summary

name(:string): The top level header for the opts documentation - Default: "Opts"
header_depth(:int): How many # to prepend before any heading - Default: 1

document(schema, doc_opts \\ [])

document(schema :: Ashton.schema(), doc_opts :: Keyword.t()) :: String.t()

name(:string): The top level header for the opts documentation - Default: "Opts"
header_depth(:int): How many # to prepend before any heading - Default: 1