selecto_components
v0.4.8

SelectoComponents.QueryContract.Guide (selecto_components v0.4.8)

Markdown guide renderer for Selecto query contracts.

The guide is a readable companion to query_contract.json. It is meant for humans, external tools, and AI assistants that benefit from compact prose over the full JSON artifact.

Link to this section Summary

Types

diagnostics()

Functions

markdown(input, opts \\ [])

Link to this section Types

Link to this type

diagnostics()

@type diagnostics() :: Selecto.Domain.Diagnostics.t()

Link to this section Functions

Link to this function

markdown(input, opts \\ [])

@spec markdown(
  term(),
  keyword()
) :: {:ok, String.t(), diagnostics()} | {:error, diagnostics()}