diff options
| author | s-ol <s+removethis@s-ol.nu> | 2021-11-13 18:19:17 +0000 |
|---|---|---|
| committer | s-ol <s+removethis@s-ol.nu> | 2025-03-02 14:24:49 +0000 |
| commit | 2e13699bdf656c7d120c71f8e9659dc946b85092 (patch) | |
| tree | e8382514df787525560ace54043eb283de90eee0 /docs/reference | |
| parent | add MIDI example (diff) | |
| download | alive-2e13699bdf656c7d120c71f8e9659dc946b85092.tar.gz alive-2e13699bdf656c7d120c71f8e9659dc946b85092.zip | |
docs: small fixes
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/04-1_result-kinds.md | 2 | ||||
| -rw-r--r-- | docs/reference/05-1_arrays.md | 2 | ||||
| -rw-r--r-- | docs/reference/05-2_structs.md | 2 | ||||
| -rw-r--r-- | docs/reference/05-3_scopes.md | 8 | ||||
| -rw-r--r-- | docs/reference/index.md | 1 |
5 files changed, 10 insertions, 5 deletions
diff --git a/docs/reference/04-1_result-kinds.md b/docs/reference/04-1_result-kinds.md index 92723c3..9f1f935 100644 --- a/docs/reference/04-1_result-kinds.md +++ b/docs/reference/04-1_result-kinds.md @@ -57,7 +57,7 @@ traces, e.g.: #(trace (lfo 2): <bang! true> trace (lfo 2): <bang! true>) -where `<num~ 1.0>` denotes an event-stream of the type `bang` that fired with a +where `<bang! true>` denotes an event-stream of the type `bang` that fired with a value of `true`. The [!][] builtin can be used to convert signal streams or constants into diff --git a/docs/reference/05-1_arrays.md b/docs/reference/05-1_arrays.md index cf10f1e..7522da7 100644 --- a/docs/reference/05-1_arrays.md +++ b/docs/reference/05-1_arrays.md @@ -8,4 +8,4 @@ from its parameters, all of which have to be of the same type. The type notation `num[3]` designates an array of three numbers, whereas the value notation `[1 2 3]` is used to show the array contents. -The [array][:array/:] module provides *Op*s for working with arrays. +The [array-][:array-/:] module provides *Op*s for working with arrays. diff --git a/docs/reference/05-2_structs.md b/docs/reference/05-2_structs.md index 83181df..11ec7ed 100644 --- a/docs/reference/05-2_structs.md +++ b/docs/reference/05-2_structs.md @@ -13,4 +13,4 @@ mapping to a value of type `num` and the key `b` mapping to a value of type `str` respectively, whereas the value notation `{a: 1 b: "hello world"}` shows the struct contents. -The [struct][:struct/:] module provides *Op*s for working with arrays. +The [struct-][:struct-/:] module provides *Op*s for working with arrays. diff --git a/docs/reference/05-3_scopes.md b/docs/reference/05-3_scopes.md index 0517677..916ea31 100644 --- a/docs/reference/05-3_scopes.md +++ b/docs/reference/05-3_scopes.md @@ -1,5 +1,9 @@ Scopes contain symbol-result mappings and are used only at *evaltime*. Unlike arrays and structs, which contain other types and have to either wholly be a -constant, ~-stream or !-steam, a single scope can contain all of these. +constant, ~-stream or !-steam, a single scope can contain any combination of these. -For this reason, scopes are used for metaprogramming and modules. +Scopes can be created using the [export][] and [export*][] builtins and are often +returned from [require][]. + +They are mostly used for grouping definitions and can be indexed using the slash +(`/`) symbol. For more information on this, see section [3.1. symbol resolution](./03-1_symbol-resolution.html). diff --git a/docs/reference/index.md b/docs/reference/index.md index ba22dba..fab5fe8 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -23,5 +23,6 @@ own module or contributing to alive, check out the 5. compound types 1. [arrays](05-1_arrays.html) 2. [structs](05-2_structs.html) + 3. [scopes](05-3_scopes.html) 6. [builtin listing](builtins.html) 7. included modules |