diff options
Diffstat (limited to 'stdlib/source/documentation')
9 files changed, 156 insertions, 156 deletions
diff --git a/stdlib/source/documentation/lux/control/concurrency/stm.lux b/stdlib/source/documentation/lux/control/concurrency/stm.lux index 662bd2768..1d2c75baa 100644 --- a/stdlib/source/documentation/lux/control/concurrency/stm.lux +++ b/stdlib/source/documentation/lux/control/concurrency/stm.lux @@ -1,14 +1,14 @@ (.using - [library - [lux {"-" if loop} - ["$" documentation {"+" documentation:}] - [data - [text {"+" \n} - ["%" format {"+" format}]]] - [macro - ["[0]" template]]]] - [\\library - ["[0]" /]]) + [library + [lux {"-" if loop} + ["$" documentation {"+" documentation:}] + [data + [text {"+" \n} + ["%" format {"+" format}]]] + [macro + ["[0]" template]]]] + [\\library + ["[0]" /]]) (documentation: (/.Var it) "A mutable cell containing a value, and observers that will be alerted of any change to it.") @@ -17,9 +17,9 @@ "Creates a new STM var, with a default value." [(var value)]) -(documentation: /.follow! +(documentation: /.changes "Creates a channel that will receive all changes to the value of the given var." - [(follow! target)]) + [(changes target)]) (documentation: (/.STM it) "A computation which updates a transaction and produces a value.") @@ -40,7 +40,7 @@ "" [..Var ..var - ..follow! + ..changes ..STM ..update ..commit! diff --git a/stdlib/source/documentation/lux/control/parser/analysis.lux b/stdlib/source/documentation/lux/control/parser/analysis.lux index a9c481f0a..c2a58f279 100644 --- a/stdlib/source/documentation/lux/control/parser/analysis.lux +++ b/stdlib/source/documentation/lux/control/parser/analysis.lux @@ -1,14 +1,14 @@ (.using - [library - [lux {"-" nat int rev local} - ["$" documentation {"+" documentation:}] - [data - [text {"+" \n} - ["%" format {"+" format}]]] - [macro - ["[0]" template]]]] - [\\library - ["[0]" /]]) + [library + [lux {"-" nat int rev local} + ["$" documentation {"+" documentation:}] + [data + [text {"+" \n} + ["%" format {"+" format}]]] + [macro + ["[0]" template]]]] + [\\library + ["[0]" /]]) (documentation: (/.Parser it) "A parser for Lux code analysis nodes.") @@ -20,7 +20,7 @@ (documentation: /.any "Matches any value, without discrimination.") -(documentation: /.end! +(documentation: /.end "Ensures there are no more inputs.") (documentation: /.end? @@ -32,15 +32,15 @@ (`` (documentation: <assertion> (format "Assert a specific " (~~ (template.text [<query>])) " value.")))))] - [/.bit /.bit!] - [/.nat /.nat!] - [/.int /.int!] - [/.rev /.rev!] - [/.frac /.frac!] - [/.text /.text!] - [/.local /.local!] - [/.foreign /.foreign!] - [/.constant /.constant!] + [/.bit /.this_bit] + [/.nat /.this_nat] + [/.int /.this_int] + [/.rev /.this_rev] + [/.frac /.this_frac] + [/.text /.this_text] + [/.local /.this_local] + [/.foreign /.this_foreign] + [/.constant /.this_constant] ) (documentation: /.tuple @@ -54,17 +54,17 @@ [..Parser ..result ..any - ..end! + ..end ..end? - ..bit ..bit! - ..nat ..nat! - ..int ..int! - ..rev ..rev! - ..frac ..frac! - ..text ..text! - ..local ..local! - ..foreign ..foreign! - ..constant ..constant! + ..bit ..this_bit + ..nat ..this_nat + ..int ..this_int + ..rev ..this_rev + ..frac ..this_frac + ..text ..this_text + ..local ..this_local + ..foreign ..this_foreign + ..constant ..this_constant ..tuple ($.default /.cannot_parse) ($.default /.unconsumed_input)] diff --git a/stdlib/source/documentation/lux/control/parser/code.lux b/stdlib/source/documentation/lux/control/parser/code.lux index c2a4cf27f..e11fb64b8 100644 --- a/stdlib/source/documentation/lux/control/parser/code.lux +++ b/stdlib/source/documentation/lux/control/parser/code.lux @@ -1,14 +1,14 @@ (.using - [library - [lux {"-" nat int rev local not symbol} - ["$" documentation {"+" documentation:}] - [data - [text {"+" \n} - ["%" format {"+" format}]]] - [macro - ["[0]" template]]]] - [\\library - ["[0]" /]]) + [library + [lux {"-" nat int rev local not symbol} + ["$" documentation {"+" documentation:}] + [data + [text {"+" \n} + ["%" format {"+" format}]]] + [macro + ["[0]" template]]]] + [\\library + ["[0]" /]]) (documentation: (/.Parser it) "A Lux code parser.") @@ -22,18 +22,18 @@ (`` (documentation: <check> (format "Checks for a specific " (~~ (template.text [<query>])) " input.")))] - [/.bit /.bit!] - [/.nat /.nat!] - [/.int /.int!] - [/.rev /.rev!] - [/.frac /.frac!] - [/.text /.text!] - [/.symbol /.symbol!] + [/.bit /.this_bit] + [/.nat /.this_nat] + [/.int /.this_int] + [/.rev /.this_rev] + [/.frac /.this_frac] + [/.text /.this_text] + [/.symbol /.this_symbol] ) -(documentation: /.this! +(documentation: /.this "Ensures the given Code is the next input." - [(this! code)]) + [(this code)]) (template [<query> <check> <desc>] [(documentation: <query> @@ -41,7 +41,7 @@ (documentation: <check> (format "Checks for a specific local " <desc> " (a " <desc> " that has no module prefix)."))] - [/.local_symbol /.local_symbol! "local symbol"] + [/.local /.this_local "local symbol"] ) (template [<name>] @@ -53,7 +53,7 @@ [/.tuple] ) -(documentation: /.end! +(documentation: /.end "Verifies there are no more inputs.") (documentation: /.end? @@ -82,30 +82,30 @@ ..any ..bit - ..bit! + ..this_bit ..nat - ..nat! + ..this_nat ..int - ..int! + ..this_int ..rev - ..rev! + ..this_rev ..frac - ..frac! + ..this_frac ..text - ..text! + ..this_text ..symbol - ..symbol! + ..this_symbol - ..this! + ..this - ..local_symbol - ..local_symbol! + ..local + ..this_local ..form ..tuple ..variant - ..end! + ..end ..end? ..result ..local diff --git a/stdlib/source/documentation/lux/control/parser/json.lux b/stdlib/source/documentation/lux/control/parser/json.lux index a9471ef9f..714fd3326 100644 --- a/stdlib/source/documentation/lux/control/parser/json.lux +++ b/stdlib/source/documentation/lux/control/parser/json.lux @@ -1,14 +1,14 @@ (.using - [library - [lux "*" - ["$" documentation {"+" documentation:}] - [data - [text {"+" \n} - ["%" format {"+" format}]]] - [macro - ["[0]" template]]]] - [\\library - ["[0]" /]]) + [library + [lux "*" + ["$" documentation {"+" documentation:}] + [data + [text {"+" \n} + ["%" format {"+" format}]]] + [macro + ["[0]" template]]]] + [\\library + ["[0]" /]]) (documentation: (/.Parser it) "A JSON parser.") @@ -37,9 +37,9 @@ (`` (documentation: <check> (format "Ensures a JSON value is a " (~~ (template.text [<read>])) ".")))] - [/.boolean? /.boolean! ..boolean] - [/.number? /.number! ..number] - [/.string? /.string! ..string] + [/.boolean? /.this_boolean ..boolean] + [/.number? /.this_number ..number] + [/.string? /.this_string ..string] ) (documentation: /.nullable @@ -76,9 +76,9 @@ ..number ..string - ..boolean? ..boolean! - ..number? ..number! - ..string? ..string! + ..boolean? ..this_boolean + ..number? ..this_number + ..string? ..this_string ..nullable ..array diff --git a/stdlib/source/documentation/lux/control/parser/synthesis.lux b/stdlib/source/documentation/lux/control/parser/synthesis.lux index 272ce901a..498b88d96 100644 --- a/stdlib/source/documentation/lux/control/parser/synthesis.lux +++ b/stdlib/source/documentation/lux/control/parser/synthesis.lux @@ -1,14 +1,14 @@ (.using - [library - [lux {"-" i64 local function loop} - ["$" documentation {"+" documentation:}] - [data - [text {"+" \n} - ["%" format {"+" format}]]] - [macro - ["[0]" template]]]] - [\\library - ["[0]" /]]) + [library + [lux {"-" i64 local function loop} + ["$" documentation {"+" documentation:}] + [data + [text {"+" \n} + ["%" format {"+" format}]]] + [macro + ["[0]" template]]]] + [\\library + ["[0]" /]]) (documentation: (/.Parser it) "A parser for the Lux compiler's synthesis nodes using during optimization.") @@ -21,7 +21,7 @@ (documentation: /.any "Yields a synthesis node without subjecting it to any analysis.") -(documentation: /.end! +(documentation: /.end "Ensures there are no more inputs.") (documentation: /.end? @@ -33,13 +33,13 @@ (`` (documentation: <assertion> (format "Checks for a specific " (~~ (template.text [<query>])) " synthesis node.")))] - [/.bit /.bit!] - [/.i64 /.i64!] - [/.f64 /.f64!] - [/.text /.text!] - [/.local /.local!] - [/.foreign /.foreign!] - [/.constant /.constant!] + [/.bit /.this_bit] + [/.i64 /.this_i64] + [/.f64 /.this_f64] + [/.text /.this_text] + [/.local /.this_local] + [/.foreign /.this_foreign] + [/.constant /.this_constant] ) (documentation: /.tuple @@ -61,16 +61,16 @@ [..Parser ..result ..any - ..end! + ..end ..end? - ..bit ..bit! - ..i64 ..i64! - ..f64 ..f64! - ..text ..text! - ..local ..local! - ..foreign ..foreign! - ..constant ..constant! + ..bit ..this_bit + ..i64 ..this_i64 + ..f64 ..this_f64 + ..text ..this_text + ..local ..this_local + ..foreign ..this_foreign + ..constant ..this_constant ..tuple ..function diff --git a/stdlib/source/documentation/lux/control/parser/text.lux b/stdlib/source/documentation/lux/control/parser/text.lux index 415090625..1859f451c 100644 --- a/stdlib/source/documentation/lux/control/parser/text.lux +++ b/stdlib/source/documentation/lux/control/parser/text.lux @@ -1,14 +1,14 @@ (.using - [library - [lux {"-" and not local} - ["$" documentation {"+" documentation:}] - [data - [text {"+" \n} - ["%" format {"+" format}]]] - [macro - ["[0]" template]]]] - [\\library - ["[0]" /]]) + [library + [lux {"-" and not local} + ["$" documentation {"+" documentation:}] + [data + [text {"+" \n} + ["%" format {"+" format}]]] + [macro + ["[0]" template]]]] + [\\library + ["[0]" /]]) (documentation: /.Offset "An offset into a block of text.") @@ -45,7 +45,7 @@ "Checks that a specific text shows up in the input." [(this reference)]) -(documentation: /.end! +(documentation: /.end "Ensure the parser's input is empty.") (documentation: /.next @@ -167,7 +167,7 @@ ..not ..not! ..this - ..end! + ..end ..next ..remaining ..range diff --git a/stdlib/source/documentation/lux/control/parser/type.lux b/stdlib/source/documentation/lux/control/parser/type.lux index 8d0a45401..331f109de 100644 --- a/stdlib/source/documentation/lux/control/parser/type.lux +++ b/stdlib/source/documentation/lux/control/parser/type.lux @@ -1,14 +1,14 @@ (.using - [library - [lux {"-" local function} - ["$" documentation {"+" documentation:}] - [data - [text {"+" \n} - ["%" format {"+" format}]]] - [macro - ["[0]" template]]]] - [\\library - ["[0]" /]]) + [library + [lux {"-" local function} + ["$" documentation {"+" documentation:}] + [data + [text {"+" \n} + ["%" format {"+" format}]]] + [macro + ["[0]" template]]]] + [\\library + ["[0]" /]]) (documentation: /.Env "An environment for type parsing.") @@ -74,9 +74,9 @@ "" [(adjusted_idx env idx)]) -(documentation: /.parameter! +(documentation: /.this_parameter "" - [(parameter! id)]) + [(this_parameter id)]) (documentation: /.existential "Yields an existential type.") @@ -115,7 +115,7 @@ ..super ..adjusted_idx - ..parameter! + ..this_parameter ..existential ..named ..recursive diff --git a/stdlib/source/documentation/lux/macro/code.lux b/stdlib/source/documentation/lux/macro/code.lux index ed5ebdc2b..1a824238f 100644 --- a/stdlib/source/documentation/lux/macro/code.lux +++ b/stdlib/source/documentation/lux/macro/code.lux @@ -1,6 +1,6 @@ (.using [library - [lux {"-" char} + [lux {"-" char local global} ["$" documentation {"+" documentation:}] [data [text @@ -10,7 +10,7 @@ [\\library ["[0]" /]]) -(documentation: /.local_symbol +(documentation: /.local "Produces a local symbol (an symbol with no module prefix).") (documentation: /.replaced @@ -21,7 +21,7 @@ (.List $.Module) ($.module /._ "" - [..local_symbol + [..local ..replaced ($.default /.bit) ($.default /.nat) diff --git a/stdlib/source/documentation/lux/target/js.lux b/stdlib/source/documentation/lux/target/js.lux index a7f688353..4a87b312a 100644 --- a/stdlib/source/documentation/lux/target/js.lux +++ b/stdlib/source/documentation/lux/target/js.lux @@ -1,14 +1,14 @@ (.using - [library - [lux {"-" char} - ["$" documentation {"+" documentation:}] - [data - [text {"+" \n} - ["%" format {"+" format}]] - [collection - ["[0]" list]]]]] - [\\library - ["[0]" /]]) + [library + [lux {"-" char} + ["$" documentation {"+" documentation:}] + [data + [text {"+" \n} + ["%" format {"+" format}]] + [collection + ["[0]" list]]]]] + [\\library + ["[0]" /]]) (.def: .public documentation (.List $.Module) @@ -39,7 +39,7 @@ ($.default /.object) ($.default /.,) ($.default /.then) - ($.default /.function!) + ($.default /.function_definition) ($.default /.function) ($.default /.closure) ($.default /.=) |