Skip to content
Beskid The Beskid Book

Beskid

Jump to a Beskid service

Beskid

Jump to a Beskid service

20.3 Generated SDK docs

Compiler SDK syntax is generated—document semantics and invariants, not obvious identifiers.

Generated SDK docs

Beskid.Compiler.* SDK sources (including syntax types) are produced by beskid_ast_reflect_gen, not hand-maintained parallel copies. When you document mirrored declarations:

  • Explain semantics and non-obvious invariants.
  • Do not restate identifier names and types already visible in the signature.
  • Never put @arg on struct fields that are not callable parameters.

Mods and analyzers consume the same AST model—lying in SDK docs breaks more than hover text.