Keyword index

Keyword index

Find a word, symbol or writing goal. Entries link directly to explanations and complete examples. Browser Find (Ctrl+F or Command+F) works on this page even before GitHub indexes the wiki.

This is a usage index, not a list of globally forbidden names. result is contextual; Text, Number, Boolean, List and Nothing are built-in names. error, fails and with also remain usable as names where the grammar expects a name. Backtick quoting permits names that would otherwise collide with reserved syntax.

Words

Word or phrase	Purpose	Reference
action	Runtime action or composed action helper	Read
and	Boolean conjunction	Read
as	Import alias or captured message result	Import alias · Message capture
assert	A Boolean assertion inside a check body	Read
Boolean	Built-in Boolean type	Read
build	Package requirement phase; also a CLI command	Read
capability	Operation inside a concept-like owner	Read
check	Reusable assertion operation; also a CLI command	Read
class	Concept-like class declaration	Read
component	Concept-like component declaration	Read
concept	Group a named contract	Read
construction	Construction inputs	Read
depends on	Reference existing concept/type dependencies	Read
do	Invoke a call in a helper/check body	Read
ensures	Boolean postcondition	Read
error type	Declare a domain error family	Read
example	Short actual-to-expected example	Read
examples	Group fixtures, operations and scenarios	Read
examples for	Attach subject context inline or from a file	Read
extend	Add members to an existing concept-like declaration	Read
fails with	Declared exceptional outcomes	Read
false	Boolean literal	Read
fixture	Typed reusable example data	Read
for	Subject in examples, or a package requirement phase	Examples · Package phase
from	Source locator in imports or examples attachments	Read
function	Top-level callable contract	Read
given	Scenario preparation step	Read
include	Compose supplied source declarations	Read
interaction	Authored communication sequence	Read
interface	Concept-like interface declaration	Read
let	Ordered local helper/check value	Read
List	Built-in generic list type	Read
local	Private owner-scoped declaration	Read
message	An authored sender-to-receiver call	Read
not	Boolean negation	Read
Nothing	Explicitly valueless result	Read
Number	Built-in numeric type	Read
observation	Operation that obtains an actual value	Read
opaque type	Type with no exposed record shape	Read
or	Boolean disjunction	Read
package	Package alias in requires package	Read
participant	Named typed endpoint in an interaction	Read
promises	Human-readable contract obligation	Read
public	Expose existing capabilities	Read
requires	Boolean precondition	Read
requires package	Configured native requirement	Read
result	Contextual postcondition result; ordinary name elsewhere	Read
return	Return a value from a test helper body	Read
returns	Declare a callable result	Read
runtime	Package requirement phase	Read
satisfies	Prose expectation that still needs verification	Read
scenario	Ordered concrete behavior example	Read
setup	Runtime state preparation operation	Read
test	Package requirement phase; also a CLI command	Read
Text	Built-in text type	Read
then	Scenario expectation	Read
true	Boolean literal	Read
type	Record or transparent alias declaration	Read
use	Select declarations from a source/library	Read
when	Scenario action	Read
with	Part of fails with	Read

Symbols

Symbol	Purpose	Reference
=>	Actual → expected in a short example	Expressions and operators
->	Interaction message direction	Interactions
?	Optional type	Types
|	Union type	Types
<T>	Generic type parameter/argument	Types
[A, B]	Tuple type; brackets also enclose list/tuple values	Types
: / =	Types, defaults, data and captures	Expressions and operators
. / (...)	Qualified selection, field access, calls or grouping	Expressions and operators
+ - * / %	Numeric operators	Expressions and operators
== != < <= > >=	Comparisons	Expressions and operators
//	Line comment	Lexical syntax
Backticks / double quotes	Names / text	Lexical syntax

By writing goal

• Optional field
• Default parameter
• Expected return value
• No return value
• Public method
• Reusable data
• Reusable test operation
• Separate examples file
• Dependency or package
• Exceptional outcome
• Relationship or sequence diagram
• Connected project and export format
• Unknown or mismatched name

Home