1. Introduction
Scope and companion documents
Section titled “Scope and companion documents”This document defines Nomi: its syntax, its static rules, what a program does when it runs, and the error text a violation gives. A feature it describes works unless its section carries a status callout.
Other documents cover the rest:
- The tour teaches the language in learning order.
- Writing Nomi says which of several legal forms to choose.
- The standard library reference documents std’s types and functions. This document names a std type only where a language rule depends on it.
- The tooling reference documents the
nomicommand,nomi.toml, dependencies and builds. - How parts of the language are built is in the implementation’s package
docs, which
AGENTS.mdmaps. - The roadmap holds open design questions.
Notation and error text
Section titled “Notation and error text”Code is shown in nomi blocks. A block that declares fn main at column 0
is a complete program; any other block is a fragment, and ... in it stands
for code left out. A comment after an expression gives its value (// 3),
or says the expression is rejected.
A compile error is quoted as the compiler prints it, in a code span:
`type mismatch: expected Byte, got Int`. A compile error stops the
program before any of it runs. A run-time fault, a trap, is quoted with the
line prefix it prints: line 3: index 7 is out of range for a Vector of length 5.
A section that a tour chapter teaches starts with a “Taught in” line that
links it. A citation §N *Heading* names a heading in chapter N.
Status callouts
Section titled “Status callouts”A callout that starts Status: not yet implemented marks text that describes intended behavior the compiler does not have yet. Each one is listed in feature-status.md’s “Aspirational language features”. All other text describes the compiler as it is.