diff options
Diffstat (limited to 'stdlib/source/documentation/lux/data')
13 files changed, 161 insertions, 162 deletions
diff --git a/stdlib/source/documentation/lux/data/binary.lux b/stdlib/source/documentation/lux/data/binary.lux index 1bc5e4146..abfdc044d 100644 --- a/stdlib/source/documentation/lux/data/binary.lux +++ b/stdlib/source/documentation/lux/data/binary.lux @@ -21,41 +21,41 @@ "" [(aggregate f init binary)]) -(documentation: /.read_8! +(documentation: /.bits_8 "Read 1 byte (8 bits) at the given index." - [(read_8! index binary)]) + [(bits_8 index binary)]) -(documentation: /.read_16! +(documentation: /.bits_16 "Read 2 bytes (16 bits) at the given index." - [(read_16! index binary)]) + [(bits_16 index binary)]) -(documentation: /.read_32! +(documentation: /.bits_32 "Read 4 bytes (32 bits) at the given index." - [(read_32! index binary)]) + [(bits_32 index binary)]) -(documentation: /.read_64! +(documentation: /.bits_64 "Read 8 bytes (64 bits) at the given index." - [(read_64! index binary)]) + [(bits_64 index binary)]) -(documentation: /.write_8! +(documentation: /.has_8! "Write 1 byte (8 bits) at the given index." - [(write_8! index value binary)]) + [(has_8! index value binary)]) -(documentation: /.write_16! +(documentation: /.has_16! "Write 2 bytes (16 bits) at the given index." - [(write_16! index value binary)]) + [(has_16! index value binary)]) -(documentation: /.write_32! +(documentation: /.has_32! "Write 4 bytes (32 bits) at the given index." - [(write_32! index value binary)]) + [(has_32! index value binary)]) -(documentation: /.write_64! +(documentation: /.has_64! "Write 8 bytes (64 bits) at the given index." - [(write_64! index value binary)]) + [(has_64! index value binary)]) -(documentation: /.copy +(documentation: /.copy! "Mutates the target binary BLOB by copying bytes from the source BLOB to it." - [(copy bytes source_offset source target_offset target)]) + [(copy! bytes source_offset source target_offset target)]) (documentation: /.slice "Yields a subset of the binary BLOB, so long as the specified range is valid." @@ -72,15 +72,15 @@ [..Binary ..empty ..aggregate - ..read_8! - ..read_16! - ..read_32! - ..read_64! - ..write_8! - ..write_16! - ..write_32! - ..write_64! - ..copy + ..bits_8 + ..bits_16 + ..bits_32 + ..bits_64 + ..has_8! + ..has_16! + ..has_32! + ..has_64! + ..copy! ..slice ..after ($.default /.index_out_of_bounds) diff --git a/stdlib/source/documentation/lux/data/collection/array.lux b/stdlib/source/documentation/lux/data/collection/array.lux index 56ef85af3..d516f1ec3 100644 --- a/stdlib/source/documentation/lux/data/collection/array.lux +++ b/stdlib/source/documentation/lux/data/collection/array.lux @@ -26,25 +26,25 @@ "" [(size array)]) -(documentation: /.read! +(documentation: /.item "" - [(read! index array)]) + [(item index array)]) -(documentation: /.write! +(documentation: /.has! "Mutate the array by writing a value to the specified index." - [(write! index value array)]) + [(has! index value array)]) -(documentation: /.delete! +(documentation: /.lacks! "Mutate the array by deleting the value at the specified index." - [(delete! index array)]) + [(lacks! index array)]) -(documentation: /.contains? +(documentation: /.has? "" - [(contains? index array)]) + [(has? index array)]) -(documentation: /.update! +(documentation: /.revised! "Mutate the array by updating the value at the specified index." - [(update! index transform array)]) + [(revised! index transform array)]) (documentation: /.upsert! (format "Mutate the array by updating the value at the specified index." @@ -63,17 +63,17 @@ "Finds out how many cells in an array are vacant." [(vacancy array)]) -(documentation: /.filter! +(documentation: /.only! "Delete every item of the array that fails to satisfy the predicate." - [(filter! p xs)]) + [(only! p xs)]) (documentation: /.example "Yields the first item in the array that satisfies the predicate." [(example p xs)]) -(documentation: /.example+ +(documentation: /.example' "Just like 'example', but with access to the index of each value." - [(example+ p xs)]) + [(example' p xs)]) (documentation: /.clone "Yields a shallow clone of the array." @@ -96,18 +96,18 @@ [..Array ..empty ..size - ..read! - ..write! - ..delete! - ..contains? - ..update! + ..item + ..has! + ..lacks! + ..has? + ..revised! ..upsert! ..copy! ..occupancy ..vacancy - ..filter! + ..only! ..example - ..example+ + ..example' ..clone ..of_list ..list diff --git a/stdlib/source/documentation/lux/data/collection/dictionary.lux b/stdlib/source/documentation/lux/data/collection/dictionary.lux index 59955b544..72bbc43a8 100644 --- a/stdlib/source/documentation/lux/data/collection/dictionary.lux +++ b/stdlib/source/documentation/lux/data/collection/dictionary.lux @@ -1,22 +1,22 @@ (.using - [library - [lux "*" - ["$" documentation {"+" documentation:}] - [control - ["<>" parser - ["<[0]>" code]]] - [data - ["[0]" text {"+" \n} - ["%" format {"+" format}]]] - [macro - [syntax {"+" syntax:}] - ["[0]" code] - ["[0]" template]]]] - [\\library - ["[0]" /]] - ["[0]" / "_" - ["[1][0]" ordered] - ["[1][0]" plist]]) + [library + [lux {"-" has revised} + ["$" documentation {"+" documentation:}] + [control + ["<>" parser + ["<[0]>" code]]] + [data + ["[0]" text {"+" \n} + ["%" format {"+" format}]]] + [macro + [syntax {"+" syntax:}] + ["[0]" code] + ["[0]" template]]]] + [\\library + ["[0]" /]] + ["[0]" / "_" + ["[1][0]" ordered] + ["[1][0]" plist]]) (documentation: (/.Dictionary key value) "A dictionary implemented as a Hash-Array Mapped Trie (HAMT).") diff --git a/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux b/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux index f98e122ad..e597d73fa 100644 --- a/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux +++ b/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux @@ -1,19 +1,19 @@ (.using - [library - [lux "*" - ["$" documentation {"+" documentation:}] - [control - ["<>" parser - ["<[0]>" code]]] - [data - ["[0]" text {"+" \n} - ["%" format {"+" format}]]] - [macro - [syntax {"+" syntax:}] - ["[0]" code] - ["[0]" template]]]] - [\\library - ["[0]" /]]) + [library + [lux {"-" has revised} + ["$" documentation {"+" documentation:}] + [control + ["<>" parser + ["<[0]>" code]]] + [data + ["[0]" text {"+" \n} + ["%" format {"+" format}]]] + [macro + [syntax {"+" syntax:}] + ["[0]" code] + ["[0]" template]]]] + [\\library + ["[0]" /]]) (documentation: (/.Dictionary key value) "A dictionary data-structure with ordered entries.") diff --git a/stdlib/source/documentation/lux/data/collection/dictionary/plist.lux b/stdlib/source/documentation/lux/data/collection/dictionary/plist.lux index fccb11c25..81ca8e29c 100644 --- a/stdlib/source/documentation/lux/data/collection/dictionary/plist.lux +++ b/stdlib/source/documentation/lux/data/collection/dictionary/plist.lux @@ -1,19 +1,19 @@ (.using - [library - [lux "*" - ["$" documentation {"+" documentation:}] - [control - ["<>" parser - ["<[0]>" code]]] - [data - ["[0]" text {"+" \n} - ["%" format {"+" format}]]] - [macro - [syntax {"+" syntax:}] - ["[0]" code] - ["[0]" template]]]] - [\\library - ["[0]" /]]) + [library + [lux {"-" has revised} + ["$" documentation {"+" documentation:}] + [control + ["<>" parser + ["<[0]>" code]]] + [data + ["[0]" text {"+" \n} + ["%" format {"+" format}]]] + [macro + [syntax {"+" syntax:}] + ["[0]" code] + ["[0]" template]]]] + [\\library + ["[0]" /]]) (documentation: (/.PList it) (format "A property list." diff --git a/stdlib/source/documentation/lux/data/collection/sequence.lux b/stdlib/source/documentation/lux/data/collection/sequence.lux index 3d719ee3e..3f25a8a2b 100644 --- a/stdlib/source/documentation/lux/data/collection/sequence.lux +++ b/stdlib/source/documentation/lux/data/collection/sequence.lux @@ -1,6 +1,6 @@ (.using [library - [lux {"-" list} + [lux {"-" list has revised} ["$" documentation {"+" documentation:}] [control ["<>" parser diff --git a/stdlib/source/documentation/lux/data/collection/set.lux b/stdlib/source/documentation/lux/data/collection/set.lux index c63ad7af0..afac731cb 100644 --- a/stdlib/source/documentation/lux/data/collection/set.lux +++ b/stdlib/source/documentation/lux/data/collection/set.lux @@ -1,20 +1,20 @@ (.using - [library - [lux {"-" list} - ["$" documentation {"+" documentation:}] - [control - ["<>" parser - ["<[0]>" code]]] - [data - ["[0]" text {"+" \n} - ["%" format {"+" format}]]] - [macro - ["[0]" template]]]] - [\\library - ["[0]" /]] - ["[0]" / "_" - ["[1][0]" multi] - ["[1][0]" ordered]]) + [library + [lux {"-" list has} + ["$" documentation {"+" documentation:}] + [control + ["<>" parser + ["<[0]>" code]]] + [data + ["[0]" text {"+" \n} + ["%" format {"+" format}]]] + [macro + ["[0]" template]]]] + [\\library + ["[0]" /]] + ["[0]" / "_" + ["[1][0]" multi] + ["[1][0]" ordered]]) (documentation: /.has "" diff --git a/stdlib/source/documentation/lux/data/collection/set/multi.lux b/stdlib/source/documentation/lux/data/collection/set/multi.lux index fd0b0499a..40c11a4d0 100644 --- a/stdlib/source/documentation/lux/data/collection/set/multi.lux +++ b/stdlib/source/documentation/lux/data/collection/set/multi.lux @@ -1,17 +1,17 @@ (.using - [library - [lux {"-" list} - ["$" documentation {"+" documentation:}] - [control - ["<>" parser - ["<[0]>" code]]] - [data - ["[0]" text {"+" \n} - ["%" format {"+" format}]]] - [macro - ["[0]" template]]]] - [\\library - ["[0]" /]]) + [library + [lux {"-" list has} + ["$" documentation {"+" documentation:}] + [control + ["<>" parser + ["<[0]>" code]]] + [data + ["[0]" text {"+" \n} + ["%" format {"+" format}]]] + [macro + ["[0]" template]]]] + [\\library + ["[0]" /]]) (documentation: (/.Set it) "A set that keeps track of repetition in its entries.") diff --git a/stdlib/source/documentation/lux/data/collection/set/ordered.lux b/stdlib/source/documentation/lux/data/collection/set/ordered.lux index bcc9bfd53..c239a9b35 100644 --- a/stdlib/source/documentation/lux/data/collection/set/ordered.lux +++ b/stdlib/source/documentation/lux/data/collection/set/ordered.lux @@ -1,17 +1,17 @@ (.using - [library - [lux {"-" list} - ["$" documentation {"+" documentation:}] - [control - ["<>" parser - ["<[0]>" code]]] - [data - ["[0]" text {"+" \n} - ["%" format {"+" format}]]] - [macro - ["[0]" template]]]] - [\\library - ["[0]" /]]) + [library + [lux {"-" list has} + ["$" documentation {"+" documentation:}] + [control + ["<>" parser + ["<[0]>" code]]] + [data + ["[0]" text {"+" \n} + ["%" format {"+" format}]]] + [macro + ["[0]" template]]]] + [\\library + ["[0]" /]]) (documentation: (/.Set it) "A set with ordered entries.") diff --git a/stdlib/source/documentation/lux/data/collection/stream.lux b/stdlib/source/documentation/lux/data/collection/stream.lux index 4d3e89a52..bba416ae1 100644 --- a/stdlib/source/documentation/lux/data/collection/stream.lux +++ b/stdlib/source/documentation/lux/data/collection/stream.lux @@ -1,6 +1,6 @@ (.using [library - [lux {"-" list} + [lux {"-" list pattern} ["$" documentation {"+" documentation:}] [control ["<>" parser diff --git a/stdlib/source/documentation/lux/data/format/json.lux b/stdlib/source/documentation/lux/data/format/json.lux index 26a14d886..78e8bd332 100644 --- a/stdlib/source/documentation/lux/data/format/json.lux +++ b/stdlib/source/documentation/lux/data/format/json.lux @@ -1,14 +1,14 @@ (.using - [library - [lux {"-" nat int rev list type or and} - ["$" documentation {"+" documentation:}] - [data - [text {"+" \n} - ["%" format {"+" format}]]] - [macro - ["[0]" template]]]] - [\\library - ["[0]" /]]) + [library + [lux {"-" nat int rev list type or and has} + ["$" documentation {"+" documentation:}] + [data + [text {"+" \n} + ["%" format {"+" format}]]] + [macro + ["[0]" template]]]] + [\\library + ["[0]" /]]) (documentation: /.json "A simple way to produce JSON literals." diff --git a/stdlib/source/documentation/lux/data/format/tar.lux b/stdlib/source/documentation/lux/data/format/tar.lux index 059234a73..df4e17788 100644 --- a/stdlib/source/documentation/lux/data/format/tar.lux +++ b/stdlib/source/documentation/lux/data/format/tar.lux @@ -1,14 +1,14 @@ (.using - [library - [lux {"-" nat int rev list type or and} - ["$" 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]" /]]) (.def: .public documentation (.List $.Module) @@ -83,7 +83,6 @@ ($.default /.Tar) ($.default /.writer) ($.default /.wrong_checksum) - ($.default /.wrong_link_flag) ($.default /.invalid_end_of_archive) ($.default /.parser)] [])) diff --git a/stdlib/source/documentation/lux/data/text/regex.lux b/stdlib/source/documentation/lux/data/text/regex.lux index 631195a86..1fb81532e 100644 --- a/stdlib/source/documentation/lux/data/text/regex.lux +++ b/stdlib/source/documentation/lux/data/text/regex.lux @@ -1,6 +1,6 @@ (.using [library - [lux "*" + [lux {"-" pattern} ["$" documentation {"+" documentation:}] [data [text {"+" \n} |