AshLua.EvalActions.Run.Docs (ash_lua v0.2.3)

Copy Markdown View Source

Implementation backing the synthesized :docs action.

Returns markdown for the scoped Lua surface, in one of three modes:

  • search set — runs AshLua.Docs.search/2 over the scoped surface and returns a ranked list of matches. The list is intended as a discovery aid; follow up with the same action using name set to one of the returned ids.
  • name set — resolves against the scoped manifest and returns the focused page (callable, record-type, named-type, or topic). The reserved name "full" returns the entire scoped page (AshLua.Docs.full_doc/1).
  • neither set — returns one line per operation (AshLua.Docs.abridged_doc/1), also reachable as "abridged".

Passing both name and search is an error.