The prelude's reference, beside the other modules'

modules/std/prelude.sz is the prelude's page, made from the docs the
prelude was compiled with, builtins included. Part III starts with the
prelude and links to it, instead of pointing at Docs/prelude.org.

🤖 Generated with [ECA](https://eca.dev)

Co-Authored-By: eca-agent <git@eca.dev>
This commit is contained in:
Linus Björnstam 2026-10-06 18:08:04 +02:00
parent bc58247994
commit 319c9df63e
2 changed files with 9 additions and 1 deletions

View file

@ -1,6 +1,11 @@
@section{Part III — The standard library} @section{Part III — The standard library}
A short tour of the standard library. Each module's full reference is its own page under @link["modules/index.html"]{Modules}; the prelude's is still @code{Docs/prelude.org}. A short tour of the standard library. Each module's full reference is its own page under @link["modules/index.html"]{Modules}.
@subsection{std/prelude}
The prelude is what every module has without importing anything: the collections and their functions, strings and characters, files and ports, Concurrent ML and scopes, and the macros the language is written with, such as @code{cond}, @code{if-let} and @code{type/derive}. Its reference also covers the builtins, the functions compiled into the runtime rather than written in Bjolang, since every program gets them with the prelude. At the REPL, @code{:show name} prints the same documentation.
For more details, see @link["modules/std/prelude.html"]{@code{(std prelude)}}.
@subsection{std/fmt} @subsection{std/fmt}

3
modules/std/prelude.sz Normal file
View file

@ -0,0 +1,3 @@
(meta (title "(std prelude)"))
@generate-docs[#:module "std prelude"]