Skip to main content

Module stdlib_docs

Module stdlib_docs 

Source
Expand description

The stdlib teaching registry: every prelude definition’s literate documentation, read once from the RAW embedded module sources (loader::prelude_module_sources — Notes included) through teach::extract_literate_docs. Hover, completion, and signature help fall back here when a name has no local definition, so md5 teaches in the editor exactly what its ## Note says in the source.

Structs§

StdlibDoc
One stdlib definition’s teaching surface.

Functions§

all
Every stdlib name with its doc, name-sorted (completion feed).
hover_md
Hover markdown for a stdlib name: the signature as code, then the prose.
stdlib_doc
The teaching surface for a stdlib prelude name, if it is one.