Pudu Docgen
Edit this page

Record

Section

Module PuduLangDocgen.Build.Overwrite

type Section = {
  uid: Str,
  meta: Array[(Str, Docgen.Meta)],
  content: Str,
  target: Str,
  source: Str,
  line: Int
}

View source

One amendment: target identity, metadata, and Markdown content

Fields

Name Type Description
uid Str
meta Array[(Str, Docgen.Meta)]
content Str
target Str
source Str
line Int
Name Description
parse The sections of an overwrite file. A header is a `---` block whose YAML is a mapping with a `uid`; a later block whose YAML is not a mapping stays Markdown. A key whose value is `*content` receives the section's Markdown instead of the body.
metaFor Metadata the sections give an identity, later sections winning.
units Modules with their declarations' documentation amended: content aimed at `summary` or `remarks` replaces that part, content aimed at `example` adds an example section, and content aimed at nothing is added after the existing documentation.