ZenQuant.Manifest (zen_quant v0.2.0)

Copy Markdown View Source

ZenQuant-specific API manifest builder.

Thin wrapper around Descripex.Manifest.build/1 that knows which ZenQuant modules to include in the manifest.

The module list is defined once in ZenQuant via use Descripex.Discoverable and accessed here through ZenQuant.__descripex_modules__/0.

Usage

manifest = ZenQuant.Manifest.build()
manifest.modules |> hd() |> Map.get(:functions) |> hd()
# => %{name: "annualize", arity: 2, spec: "annualize(...) :: float()", ...}

Summary

Functions

Build the complete API manifest from all ZenQuant modules.

Returns the list of ZenQuant modules included in the manifest.

Functions

build()

@spec build() :: map()

Build the complete API manifest from all ZenQuant modules.

modules()

@spec modules() :: [module()]

Returns the list of ZenQuant modules included in the manifest.