diff options
| author | Eduardo Julian | 2021-08-29 18:30:29 -0400 |
|---|---|---|
| committer | Eduardo Julian | 2021-08-29 18:30:29 -0400 |
| commit | ff537895fe9c24f37a0ce11b640af5d4882571a5 (patch) | |
| tree | f59778fa4163277d3ca3a1df450af82a401debb3 /stdlib/source/documentation/lux.lux | |
| parent | 1680d4d8bc4046ed4728413f1e7cfd77aa7e84b7 (diff) | |
Better parameterized type documentation.
Diffstat (limited to 'stdlib/source/documentation/lux.lux')
| -rw-r--r-- | stdlib/source/documentation/lux.lux | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/stdlib/source/documentation/lux.lux b/stdlib/source/documentation/lux.lux index 712814250..b7f1025ad 100644 --- a/stdlib/source/documentation/lux.lux +++ b/stdlib/source/documentation/lux.lux @@ -54,13 +54,13 @@ (format "The type of things whose type is undefined." \n "Useful for expressions that cause errors or other 'extraordinary' conditions.")) -(documentation: /.List +(documentation: (/.List item) "A potentially empty list of values.") (documentation: /.Bit "Your standard, run-of-the-mill boolean values (as #0 or #1 bits).") -(documentation: /.I64 +(documentation: (/.I64 kind) "64-bit integers without any semantics.") (documentation: /.Nat @@ -83,7 +83,7 @@ (documentation: /.Name "A name. It is used as part of Lux syntax to represent identifiers and tags.") -(documentation: /.Maybe +(documentation: (/.Maybe value) "A potentially missing value.") (documentation: /.Type @@ -92,7 +92,7 @@ (documentation: /.Location "Locations are for specifying the location of Code nodes in Lux files during compilation.") -(documentation: /.Ann +(documentation: (/.Ann meta_data datum) "The type of things that can be annotated with meta-data of arbitrary types.") (documentation: /.Code @@ -116,7 +116,7 @@ (documentation: /.Global "Represents all the data associated with a global constant.") -(documentation: /.Either +(documentation: (/.Either left right) "A choice between two values of different types.") (documentation: /.Module @@ -133,7 +133,7 @@ \n "It is provided to macros during their invocation, so they can access compiler data." \n "Caveat emptor: Avoid fiddling with it, unless you know what you're doing.")) -(documentation: /.Meta +(documentation: (/.Meta it) (format "Computations that can have access to the state of the compiler." \n "These computations may fail, or modify the state of the compiler.")) @@ -1020,9 +1020,9 @@ ..true ..:let ..try - ($.default /.Code') + ($.default (/.Code' w)) ($.default /.Alias) - ($.default /.Bindings) + ($.default (/.Bindings key value)) ($.default /.Ref) ($.default /.Scope) ($.default /.Source) |