documentation
Use the left sidebar to navigate the generated documentation.
Read the the tutorial first.
Documentation for translated C headers such as unistd is omitted;
just read the source.
Crow is in alpha state, so many functions are still missing. Consider filing an issue.
Conventions
Immutable types
Most types in crow are immutable.
A function on an immutable type returns a new value instead of modifying its argument.
For brevity, documentation still uses action verbs to describe functions on immutable types.
For example, the documentation for - from
crow/col/map says: "Remove a key.".
This really means that the function returns a new dictionary with the key removed,
and does not modify its argument.
Iff
It's not a typo: iff means "if and only iff".
For example, the documentation for is-empty from
crow/col/arr says:
"true iff a.size == 0."
Since it is true only if the size is 0, that means that if a.size != 0,
is-empty will return false.
In contrast, interpret if literally.
If a function says, "throws if x is out of bounds",
that's not a promise that it will never throw if x is in bounds.