optimal v0.3.6 Optimal.Doc View Source

Automatic opt documentation, to be placed into your function docstrings

Link to this section Summary

Link to this section Functions

Link to this function document(schema, doc_opts \\ []) View Source
document(schema :: Optimal.schema(), doc_opts :: Keyword.t()) :: String.t()

Opts

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