docs.errors¶
Render every runtime error and note as a markdown reference page.
The entries are read from the source itself rather than written by hand: every taught error and every teach-once note the runner can print, with the runtime-filled parts shown as ⟨like this⟩. A page that regenerates this on each docs build can never drift from what the runner actually says. Without --out the page is the task's stdout.
| Parameter | Type | Default | Description |
|---|---|---|---|
--out=PATH |
path | file to write the page into; omitted = stdout |
Returns: a list of text (or null)