diff options
author | Eduardo Julian | 2022-07-08 17:47:23 -0400 |
---|---|---|
committer | Eduardo Julian | 2022-07-08 17:47:23 -0400 |
commit | 7976268575e7c6910dfba2d2733e8cc1883678e7 (patch) | |
tree | 0ce156081612235c0df5e2ad9167be3fc5d75c6c /stdlib/source/documentation/lux/data | |
parent | 39325bb36c6f6459c861ef12f9e99b9e66b52594 (diff) |
Re-named the "documentation" macro to "definition".
Diffstat (limited to 'stdlib/source/documentation/lux/data')
34 files changed, 326 insertions, 326 deletions
diff --git a/stdlib/source/documentation/lux/data/binary.lux b/stdlib/source/documentation/lux/data/binary.lux index 09f2b8b87..879785079 100644 --- a/stdlib/source/documentation/lux/data/binary.lux +++ b/stdlib/source/documentation/lux/data/binary.lux @@ -39,40 +39,40 @@ ($.default \\parser.location) ($.default \\parser.code) - ($.documentation \\parser.Offset + ($.definition \\parser.Offset "An offset for reading within binary data.") - ($.documentation (\\parser.Parser it) + ($.definition (\\parser.Parser it) "A parser for raw binary data.") - ($.documentation \\parser.result + ($.definition \\parser.result "Runs a parser and checks that all the binary data was read by it." [(result parser input)]) - ($.documentation \\parser.end? + ($.definition \\parser.end? "Checks whether there is no more data to read.") - ($.documentation \\parser.offset + ($.definition \\parser.offset "The current offset (i.e. how much data has been read).") - ($.documentation \\parser.remaining + ($.definition \\parser.remaining "How much of the data remains to be read.") - ($.documentation \\parser.Size + ($.definition \\parser.Size "The size of a chunk of data within a binary array.") - ($.documentation \\parser.rec + ($.definition \\parser.rec "Tie the knot for a recursive parser.") - ($.documentation \\parser.any + ($.definition \\parser.any "Does no parsing, and just returns a dummy value.") - ($.documentation \\parser.segment + ($.definition \\parser.segment "Parses a chunk of data of a given size." [(segment size)]) (,, (with_template [<size> <name>] - [($.documentation <name> + [($.definition <name> (format "Parses a block of data prefixed with a size that is " (%.nat <size>) " bytes long."))] [08 \\parser.binary_8] @@ -82,7 +82,7 @@ )) (,, (with_template [<size> <name>] - [($.documentation <name> + [($.definition <name> (format "Parses a block of (UTF-8 encoded) text prefixed with a size that is " (%.nat <size>) " bytes long."))] [08 \\parser.utf8_8] @@ -92,7 +92,7 @@ )) (,, (with_template [<size> <name>] - [($.documentation <name> + [($.definition <name> (format "Parses a sequence of values prefixed with a size that is " (%.nat <size>) " bytes long."))] [08 \\parser.sequence_8] @@ -101,11 +101,11 @@ [64 \\parser.sequence_64] )) - ($.documentation \\parser.list + ($.definition \\parser.list "Parses an arbitrarily long list of values." [(list value)]) - ($.documentation \\parser.set + ($.definition \\parser.set "" [(set hash value)])] []))) @@ -146,38 +146,38 @@ ($.default \\format.location) ($.default \\format.code) - ($.documentation \\format.Mutation + ($.definition \\format.Mutation "A mutation of binary data, tracking where in the data to transform.") - ($.documentation \\format.Specification + ($.definition \\format.Specification "A description of how to transform binary data.") - ($.documentation \\format.no_op + ($.definition \\format.no_op "A specification for empty binary data.") - ($.documentation \\format.instance + ($.definition \\format.instance "Given a specification of how to construct binary data, yields a binary blob that matches it.") - ($.documentation (\\format.Format it) + ($.definition (\\format.Format it) "An operation that knows how to write information into a binary blob.") - ($.documentation \\format.result + ($.definition \\format.result "Yields a binary blob with all the information written to it." [(result format value)]) - ($.documentation \\format.or + ($.definition \\format.or "" [(or left right)]) - ($.documentation \\format.and + ($.definition \\format.and "" [(and pre post)]) - ($.documentation \\format.rec + ($.definition \\format.rec "A combinator for recursive formats." [(rec body)]) - ($.documentation \\format.segment + ($.definition \\format.segment "Writes at most 'size' bytes of an input binary blob." [(segment size)])] [])) @@ -192,58 +192,58 @@ ($.default /.equivalence) ($.default /.monoid) - ($.documentation /.Binary + ($.definition /.Binary "A binary BLOB of data.") - ($.documentation /.empty + ($.definition /.empty "A fresh/empty binary BLOB of the specified size." [(empty size)]) - ($.documentation /.mix + ($.definition /.mix "" [(mix f init binary)]) - ($.documentation /.bits_8 + ($.definition /.bits_8 "Read 1 byte (8 bits) at the given index." [(bits_8 index binary)]) - ($.documentation /.bits_16 + ($.definition /.bits_16 "Read 2 bytes (16 bits) at the given index." [(bits_16 index binary)]) - ($.documentation /.bits_32 + ($.definition /.bits_32 "Read 4 bytes (32 bits) at the given index." [(bits_32 index binary)]) - ($.documentation /.bits_64 + ($.definition /.bits_64 "Read 8 bytes (64 bits) at the given index." [(bits_64 index binary)]) - ($.documentation /.has_8! + ($.definition /.has_8! "Write 1 byte (8 bits) at the given index." [(has_8! index value binary)]) - ($.documentation /.has_16! + ($.definition /.has_16! "Write 2 bytes (16 bits) at the given index." [(has_16! index value binary)]) - ($.documentation /.has_32! + ($.definition /.has_32! "Write 4 bytes (32 bits) at the given index." [(has_32! index value binary)]) - ($.documentation /.has_64! + ($.definition /.has_64! "Write 8 bytes (64 bits) at the given index." [(has_64! index value binary)]) - ($.documentation /.copy! + ($.definition /.copy! "Mutates the target binary BLOB by copying bytes from the source BLOB to it." [(copy! bytes source_offset source target_offset target)]) - ($.documentation /.slice + ($.definition /.slice "Yields a subset of the binary BLOB, so long as the specified range is valid." [(slice offset length binary)]) - ($.documentation /.after + ($.definition /.after "Yields a binary BLOB with at most the specified number of bytes removed." [(after bytes binary)])] [..\\format diff --git a/stdlib/source/documentation/lux/data/bit.lux b/stdlib/source/documentation/lux/data/bit.lux index 25b1262d2..a3c641987 100644 --- a/stdlib/source/documentation/lux/data/bit.lux +++ b/stdlib/source/documentation/lux/data/bit.lux @@ -22,7 +22,7 @@ ($.default /.conjunction) ($.default /.codec) - ($.documentation /.complement + ($.definition /.complement (format "Generates the complement of a predicate." \n "That is a predicate that returns the oposite of the original predicate."))] [])) diff --git a/stdlib/source/documentation/lux/data/collection/array.lux b/stdlib/source/documentation/lux/data/collection/array.lux index c4ce92a7a..3517b2eeb 100644 --- a/stdlib/source/documentation/lux/data/collection/array.lux +++ b/stdlib/source/documentation/lux/data/collection/array.lux @@ -22,75 +22,75 @@ ($.default /.every?) ($.default /.any?) - ($.documentation (/.Array it) + ($.definition (/.Array it) "Mutable arrays.") - ($.documentation /.empty + ($.definition /.empty "An empty array of the specified size." [(empty size)]) - ($.documentation /.size + ($.definition /.size "" [(size array)]) - ($.documentation /.item + ($.definition /.item "" [(item index array)]) - ($.documentation /.has! + ($.definition /.has! "Mutate the array by writing a value to the specified index." [(has! index value array)]) - ($.documentation /.lacks! + ($.definition /.lacks! "Mutate the array by deleting the value at the specified index." [(lacks! index array)]) - ($.documentation /.has? + ($.definition /.has? "" [(has? index array)]) - ($.documentation /.revised! + ($.definition /.revised! "Mutate the array by updating the value at the specified index." [(revised! index transform array)]) - ($.documentation /.upsert! + ($.definition /.upsert! (format "Mutate the array by updating the value at the specified index." \n "If there is no value, update and write the default value given.") [(upsert! index default transform array)]) - ($.documentation /.copy! + ($.definition /.copy! "Writes the contents of one array into the other." [(copy! length src_start src_array dest_start dest_array)]) - ($.documentation /.occupancy + ($.definition /.occupancy "Finds out how many cells in an array are occupied." [(occupancy array)]) - ($.documentation /.vacancy + ($.definition /.vacancy "Finds out how many cells in an array are vacant." [(vacancy array)]) - ($.documentation /.only! + ($.definition /.only! "Delete every item of the array that fails to satisfy the predicate." [(only! p xs)]) - ($.documentation /.example + ($.definition /.example "Yields the first item in the array that satisfies the predicate." [(example p xs)]) - ($.documentation /.example' + ($.definition /.example' "Just like 'example', but with access to the index of each value." [(example' p xs)]) - ($.documentation /.clone + ($.definition /.clone "Yields a shallow clone of the array." [(clone xs)]) - ($.documentation /.of_list + ($.definition /.of_list "" [(of_list xs)]) - ($.documentation /.list + ($.definition /.list (format "Yields a list with every non-empty item in the array." \n "Can use the optional default value when encountering an empty cell in the array.") [(list {.#None} array) diff --git a/stdlib/source/documentation/lux/data/collection/bits.lux b/stdlib/source/documentation/lux/data/collection/bits.lux index 522f7eccd..648541759 100644 --- a/stdlib/source/documentation/lux/data/collection/bits.lux +++ b/stdlib/source/documentation/lux/data/collection/bits.lux @@ -21,26 +21,26 @@ ($.default /.or) ($.default /.xor) - ($.documentation /.Bits + ($.definition /.Bits "A bit-map.") - ($.documentation /.size + ($.definition /.size "Measures the size of a bit-map by counting all the 1s in the bit-map." [(size bits)]) - ($.documentation /.capacity + ($.definition /.capacity "" [(capacity bits)]) - ($.documentation /.bit + ($.definition /.bit "" [(bit index bits)]) - ($.documentation /.intersects? + ($.definition /.intersects? "" [(intersects? reference sample)]) - ($.documentation /.not + ($.definition /.not "" [(not input)])] [])) diff --git a/stdlib/source/documentation/lux/data/collection/dictionary.lux b/stdlib/source/documentation/lux/data/collection/dictionary.lux index 99f6342b4..6cc473b7f 100644 --- a/stdlib/source/documentation/lux/data/collection/dictionary.lux +++ b/stdlib/source/documentation/lux/data/collection/dictionary.lux @@ -24,61 +24,61 @@ ($.default /.equivalence) ($.default /.functor) - ($.documentation (/.Dictionary key value) + ($.definition (/.Dictionary key value) "A dictionary implemented as a Hash-Array Mapped Trie (HAMT).") - ($.documentation /.empty + ($.definition /.empty "An empty dictionary." [(empty key_hash)]) - ($.documentation /.has + ($.definition /.has "" [(has key val dict)]) - ($.documentation /.lacks + ($.definition /.lacks "" [(lacks key dict)]) - ($.documentation /.value + ($.definition /.value "" [(value key dict)]) - ($.documentation /.key? + ($.definition /.key? "" [(key? dict key)]) - ($.documentation /.has' + ($.definition /.has' "Only puts the KV-pair if the key is not already present." [(has' key val dict)]) - ($.documentation /.revised + ($.definition /.revised "Transforms the value located at key (if available), using the given function." [(revised key f dict)]) - ($.documentation /.revised' + ($.definition /.revised' (format "Updates the value at the key; if it exists." \n "Otherwise, puts a value by applying the function to a default.") [(revised' key default f dict)]) - ($.documentation /.of_list + ($.definition /.of_list "" [(of_list key_hash kvs)]) - ($.documentation /.composite + ($.definition /.composite (format "Merges 2 dictionaries." \n "If any collisions with keys occur, the values of dict2 will overwrite those of dict1.") [(composite dict2 dict1)]) - ($.documentation /.composite_with + ($.definition /.composite_with (format "Merges 2 dictionaries." \n "If any collisions with keys occur, a new value will be computed by applying 'f' to the values of dict2 and dict1.") [(composite_with f dict2 dict1)]) - ($.documentation /.re_bound + ($.definition /.re_bound "If there is a value under 'from_key', remove 'from_key' and store the value under 'to_key'." [(re_bound from_key to_key dict)]) - ($.documentation /.sub + ($.definition /.sub "A sub-dictionary, with only the specified keys." [(sub keys dict)])] [/ordered.documentation])) diff --git a/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux b/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux index 64f18f260..232e3bcdf 100644 --- a/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux +++ b/stdlib/source/documentation/lux/data/collection/dictionary/ordered.lux @@ -21,46 +21,46 @@ ($.default /.values) ($.default /.equivalence) - ($.documentation (/.Dictionary key value) + ($.definition (/.Dictionary key value) "A dictionary data-structure with ordered entries.") - ($.documentation /.empty + ($.definition /.empty "An empty dictionary, employing the given order." [(empty order)]) - ($.documentation /.value + ($.definition /.value "" [(value key dict)]) - ($.documentation /.key? + ($.definition /.key? "" [(key? dict key)]) (,, (with_template [<name>] - [(`` ($.documentation <name> + [(`` ($.definition <name> (format "Yields value under the " (,, (template.text [<name>])) "imum key.")))] [/.min] [/.max] )) - ($.documentation /.size + ($.definition /.size "" [(size dict)]) - ($.documentation /.has + ($.definition /.has "" [(has key value dict)]) - ($.documentation /.lacks + ($.definition /.lacks "" [(lacks key dict)]) - ($.documentation /.revised + ($.definition /.revised "" [(revised key transform dict)]) - ($.documentation /.of_list + ($.definition /.of_list "" [(of_list order list)])] []))) diff --git a/stdlib/source/documentation/lux/data/collection/list.lux b/stdlib/source/documentation/lux/data/collection/list.lux index 60c60b480..0e413e1d7 100644 --- a/stdlib/source/documentation/lux/data/collection/list.lux +++ b/stdlib/source/documentation/lux/data/collection/list.lux @@ -32,133 +32,133 @@ ($.default /.every?) ($.default /.any?) - ($.documentation /.mixes + ($.definition /.mixes "" [(mixes f init inputs)]) - ($.documentation /.reversed + ($.definition /.reversed "" [(reversed xs)]) - ($.documentation /.only + ($.definition /.only "A list with only values that satisfy the predicate." [(only keep? xs)]) - ($.documentation /.partition + ($.definition /.partition "Divide the list into all elements that satisfy a predicate, and all elements that do not." [(partition satisfies? list)]) - ($.documentation /.pairs + ($.definition /.pairs "Cut the list into pairs of 2." [(pairs list)]) - ($.documentation /.split_at + ($.definition /.split_at "" [(split_at n xs)]) - ($.documentation /.split_when + ($.definition /.split_when "Segment the list by using a predicate to tell when to cut." [(split_when predicate xs)]) - ($.documentation /.sub + ($.definition /.sub "Segment the list into sub-lists of (at most) the given size." [(sub size list)]) - ($.documentation /.repeated + ($.definition /.repeated "A list of the value x, repeated n times." [(repeated n x)]) - ($.documentation /.iterations + ($.definition /.iterations "Generates a list element by element until the function returns .#None." [(iterations f x)]) - ($.documentation /.one + ($.definition /.one "" [(one check xs)]) - ($.documentation /.all + ($.definition /.all "" [(all check xs)]) - ($.documentation /.example + ($.definition /.example "Yields the first value in the list that satisfies the predicate." [(example predicate xs)]) - ($.documentation /.interposed + ($.definition /.interposed "Puts a value between every two elements in the list." [(interposed sep xs)]) - ($.documentation /.size + ($.definition /.size "" [(size list)]) - ($.documentation /.item + ($.definition /.item "Fetches the element at the specified index." [(item i xs)]) - ($.documentation /.sorted + ($.definition /.sorted "A list ordered by a comparison function." [(sorted < xs)]) - ($.documentation /.empty? + ($.definition /.empty? "" [(empty? xs)]) - ($.documentation /.member? + ($.definition /.member? "" [(member? eq xs x)]) (,, (with_template [<name> <doc>] - [($.documentation <name> + [($.definition <name> <doc>)] [/.head "Yields the first element of a list."] [/.tail "For a list of size N, yields the N-1 elements after the first one."] )) - ($.documentation /.indices + ($.definition /.indices "Produces all the valid indices for a given size." [(indices size)]) - ($.documentation /.zipped + ($.definition /.zipped "Create list zippers with the specified number of input lists." [(def zipped_2 (zipped 2)) (def zipped_3 (zipped 3)) (zipped_3 xs ys zs) ((zipped 3) xs ys zs)]) - ($.documentation /.zipped_with + ($.definition /.zipped_with "Create list zippers with the specified number of input lists." [(def zipped_with_2 (zipped_with 2)) (def zipped_with_3 (zipped_with 3)) (zipped_with_2 + xs ys) ((zipped_with 2) + xs ys)]) - ($.documentation /.last + ($.definition /.last "" [(last xs)]) - ($.documentation /.inits + ($.definition /.inits (format "For a list of size N, yields the first N-1 elements." \n "Will yield a .#None for empty lists.") [(inits xs)]) - ($.documentation /.together + ($.definition /.together "The sequential combination of all the lists.") - ($.documentation /.with + ($.definition /.with "Enhances a monad with List functionality." [(with monad)]) - ($.documentation /.lifted + ($.definition /.lifted "Wraps a monadic value with List machinery." [(lifted monad)]) - ($.documentation /.enumeration + ($.definition /.enumeration "Pairs every element in the list with its index, starting at 0." [(enumeration xs)]) - ($.documentation /.when + ($.definition /.when "Can be used as a guard in (co)monadic be/do expressions." [(do monad [value (do_something 1 2 3) diff --git a/stdlib/source/documentation/lux/data/collection/list/property.lux b/stdlib/source/documentation/lux/data/collection/list/property.lux index b94d44263..df68a5963 100644 --- a/stdlib/source/documentation/lux/data/collection/list/property.lux +++ b/stdlib/source/documentation/lux/data/collection/list/property.lux @@ -19,27 +19,27 @@ ($.default /.values) ($.default /.equivalence) - ($.documentation (/.List it) + ($.definition (/.List it) (format "A property list." \n "It's a simple dictionary-like structure with Text keys.")) - ($.documentation /.value + ($.definition /.value "" [(value key properties)]) - ($.documentation /.contains? + ($.definition /.contains? "" [(contains? key properties)]) - ($.documentation /.has + ($.definition /.has "" [(has key val properties)]) - ($.documentation /.revised + ($.definition /.revised "" [(revised key f properties)]) - ($.documentation /.lacks + ($.definition /.lacks "" [(lacks key properties)])] [])) diff --git a/stdlib/source/documentation/lux/data/collection/queue.lux b/stdlib/source/documentation/lux/data/collection/queue.lux index 935b0dfc3..5b96e8a10 100644 --- a/stdlib/source/documentation/lux/data/collection/queue.lux +++ b/stdlib/source/documentation/lux/data/collection/queue.lux @@ -17,29 +17,29 @@ ($.default /.equivalence) ($.default /.functor) - ($.documentation (/.Queue it) + ($.definition (/.Queue it) "A first-in, first-out sequential data-structure.") - ($.documentation /.of_list + ($.definition /.of_list "" [(of_list entries)]) - ($.documentation /.list + ($.definition /.list "" [(list queue)]) - ($.documentation /.front + ($.definition /.front "Yields the first value in the queue, if any.") - ($.documentation /.member? + ($.definition /.member? "" [(member? equivalence queue member)]) - ($.documentation /.next + ($.definition /.next "" [(next queue)]) - ($.documentation /.end + ($.definition /.end "" [(end val queue)])] [/priority.documentation])) diff --git a/stdlib/source/documentation/lux/data/collection/queue/priority.lux b/stdlib/source/documentation/lux/data/collection/queue/priority.lux index 4c6303902..36f889902 100644 --- a/stdlib/source/documentation/lux/data/collection/queue/priority.lux +++ b/stdlib/source/documentation/lux/data/collection/queue/priority.lux @@ -19,11 +19,11 @@ ($.default /.next) ($.default /.empty?) - ($.documentation /.member? + ($.definition /.member? "" [(member? equivalence queue member)]) - ($.documentation /.end + ($.definition /.end "" [(end priority value queue)])] [])) diff --git a/stdlib/source/documentation/lux/data/collection/sequence.lux b/stdlib/source/documentation/lux/data/collection/sequence.lux index 9bc09f736..fc8c6fab6 100644 --- a/stdlib/source/documentation/lux/data/collection/sequence.lux +++ b/stdlib/source/documentation/lux/data/collection/sequence.lux @@ -24,42 +24,42 @@ ($.default /.every?) ($.default /.any?) - ($.documentation (/.Sequence it) + ($.definition (/.Sequence it) "A sequential data-structure with fast random access.") - ($.documentation /.suffix + ($.definition /.suffix "" [(suffix val sequence)]) - ($.documentation /.within_bounds? + ($.definition /.within_bounds? "Determines whether the index is within the bounds of the sequence." [(within_bounds? sequence idx)]) - ($.documentation /.item + ($.definition /.item "" [(item idx sequence)]) - ($.documentation /.has + ($.definition /.has "" [(has idx val sequence)]) - ($.documentation /.revised + ($.definition /.revised "" [(revised idx f sequence)]) - ($.documentation /.prefix + ($.definition /.prefix "" [(prefix sequence)]) - ($.documentation /.list + ($.definition /.list "" [(list sequence)]) - ($.documentation /.member? + ($.definition /.member? "" [(member? equivalence sequence val)]) - ($.documentation /.sequence + ($.definition /.sequence "Sequence literals." [(is (Sequence Nat) (sequence 12 34 56 78 90))])] diff --git a/stdlib/source/documentation/lux/data/collection/set.lux b/stdlib/source/documentation/lux/data/collection/set.lux index 37024e63b..00d989bca 100644 --- a/stdlib/source/documentation/lux/data/collection/set.lux +++ b/stdlib/source/documentation/lux/data/collection/set.lux @@ -30,23 +30,23 @@ ($.default /.of_list) ($.default /.predicate) - ($.documentation /.has + ($.definition /.has "" [(has elem set)]) - ($.documentation /.difference + ($.definition /.difference "" [(difference sub base)]) - ($.documentation /.intersection + ($.definition /.intersection "" [(intersection filter base)]) - ($.documentation /.sub? + ($.definition /.sub? "" [(sub? super sub)]) - ($.documentation /.super? + ($.definition /.super? "" [(super? sub super)])] [/multi.documentation diff --git a/stdlib/source/documentation/lux/data/collection/set/multi.lux b/stdlib/source/documentation/lux/data/collection/set/multi.lux index d6d0947dc..3f06fe230 100644 --- a/stdlib/source/documentation/lux/data/collection/set/multi.lux +++ b/stdlib/source/documentation/lux/data/collection/set/multi.lux @@ -25,33 +25,33 @@ ($.default /.intersection) ($.default /.difference) - ($.documentation (/.Set it) + ($.definition (/.Set it) "A set that keeps track of repetition in its entries.") - ($.documentation /.has + ($.definition /.has "" [(has multiplicity elem set)]) - ($.documentation /.lacks + ($.definition /.lacks "" [(lacks multiplicity elem set)]) - ($.documentation /.multiplicity + ($.definition /.multiplicity "" [(multiplicity set elem)]) - ($.documentation /.sub? + ($.definition /.sub? "Is 'subject' a sub-set of 'reference'?" [(sub? reference subject)]) - ($.documentation /.support + ($.definition /.support "A set of the unique (non repeated) members." [(support set)]) - ($.documentation /.member? + ($.definition /.member? "" [(member? set elem)]) - ($.documentation /.super? + ($.definition /.super? "Is 'subject' a super-set of 'reference'?")] [])) diff --git a/stdlib/source/documentation/lux/data/collection/set/ordered.lux b/stdlib/source/documentation/lux/data/collection/set/ordered.lux index 0b8dba28e..6581303a4 100644 --- a/stdlib/source/documentation/lux/data/collection/set/ordered.lux +++ b/stdlib/source/documentation/lux/data/collection/set/ordered.lux @@ -23,30 +23,30 @@ ($.default /.intersection) ($.default /.equivalence) - ($.documentation (/.Set it) + ($.definition (/.Set it) "A set with ordered entries.") - ($.documentation /.member? + ($.definition /.member? "" [(member? set elem)]) - ($.documentation /.has + ($.definition /.has "" [(has elem set)]) - ($.documentation /.lacks + ($.definition /.lacks "" [(lacks elem set)]) - ($.documentation /.difference + ($.definition /.difference "" [(difference param subject)]) - ($.documentation /.sub? + ($.definition /.sub? "Is 'sub' a sub-set of 'super'?" [(sub? super sub)]) - ($.documentation /.super? + ($.definition /.super? "Is 'super' a super-set of 'sub'?" [(super? sub super)])] [])) diff --git a/stdlib/source/documentation/lux/data/collection/stack.lux b/stdlib/source/documentation/lux/data/collection/stack.lux index defa3f836..0faad223b 100644 --- a/stdlib/source/documentation/lux/data/collection/stack.lux +++ b/stdlib/source/documentation/lux/data/collection/stack.lux @@ -18,18 +18,18 @@ ($.default /.equivalence) ($.default /.functor) - ($.documentation (/.Stack it) + ($.definition (/.Stack it) "A first-in, last-out sequential data-structure.") - ($.documentation /.value + ($.definition /.value "Yields the top value in the stack, if any." [(value stack)]) - ($.documentation /.next + ($.definition /.next "" [(next stack)]) - ($.documentation /.top + ($.definition /.top "" [(top value stack)])] [])) diff --git a/stdlib/source/documentation/lux/data/collection/stream.lux b/stdlib/source/documentation/lux/data/collection/stream.lux index 393765c2f..7f6b412cf 100644 --- a/stdlib/source/documentation/lux/data/collection/stream.lux +++ b/stdlib/source/documentation/lux/data/collection/stream.lux @@ -23,36 +23,36 @@ ($.default /.split_when) ($.default /.split_at) - ($.documentation (/.Stream it) + ($.definition (/.Stream it) "An infinite sequence of values.") - ($.documentation /.iterations + ($.definition /.iterations "A stateful way of infinitely calculating the values of a stream." [(iterations step init)]) - ($.documentation /.repeated + ($.definition /.repeated "Repeat a value forever." [(repeated x)]) - ($.documentation /.cycle + ($.definition /.cycle "Go over the elements of a list forever." [(cycle [start next])]) - ($.documentation /.item + ($.definition /.item "" [(item idx stream)]) - ($.documentation /.only + ($.definition /.only "A new stream only with items that satisfy the predicate." [(only predicate stream)]) - ($.documentation /.partition + ($.definition /.partition (format "Split a stream in two based on a predicate." \n "The left side contains all entries for which the predicate is #1." \n "The right side contains all entries for which the predicate is #0.") [(partition left? xs)]) - ($.documentation /.pattern + ($.definition /.pattern (format "Allows destructuring of streams in pattern-matching expressions." \n "Caveat emptor: Only use it for destructuring, and not for testing values within the streams.") [(let [(pattern x y z _tail) (some_stream_func +1 +2 +3)] diff --git a/stdlib/source/documentation/lux/data/collection/tree.lux b/stdlib/source/documentation/lux/data/collection/tree.lux index fca76d251..4e063f788 100644 --- a/stdlib/source/documentation/lux/data/collection/tree.lux +++ b/stdlib/source/documentation/lux/data/collection/tree.lux @@ -18,22 +18,22 @@ "" [($.default \\parser.cannot_move_further) - ($.documentation (\\parser.Parser it) + ($.definition (\\parser.Parser it) "A parser of arbitrary trees.") - ($.documentation \\parser.result' + ($.definition \\parser.result' "Applies the parser against a tree zipper." [(result' parser zipper)]) - ($.documentation \\parser.result + ($.definition \\parser.result "Applies the parser against a tree." [(result parser tree)]) - ($.documentation \\parser.value + ($.definition \\parser.value "Yields the value inside the current tree node.") (,, (with_template [<name> <doc>] - [($.documentation <name> + [($.definition <name> <doc>)] [\\parser.down "Move down."] @@ -61,22 +61,22 @@ ($.default /.functor) ($.default /.mix) - ($.documentation (/.Tree it) + ($.definition (/.Tree it) "A generic tree data-structure.") - ($.documentation /.flat + ($.definition /.flat "All the leaf values of the tree, in order." [(flat tree)]) - ($.documentation /.leaf + ($.definition /.leaf "" [(leaf value)]) - ($.documentation /.branch + ($.definition /.branch "" [(branch value children)]) - ($.documentation /.tree + ($.definition /.tree "Tree literals." [(is (Tree Nat) (tree 12 diff --git a/stdlib/source/documentation/lux/data/collection/tree/finger.lux b/stdlib/source/documentation/lux/data/collection/tree/finger.lux index fe0488db4..fbaac3b6f 100644 --- a/stdlib/source/documentation/lux/data/collection/tree/finger.lux +++ b/stdlib/source/documentation/lux/data/collection/tree/finger.lux @@ -15,33 +15,33 @@ [($.default /.tag) ($.default /.root) - ($.documentation (/.Tree @ tag value) + ($.definition (/.Tree @ tag value) "A finger tree.") - ($.documentation (/.Builder @ tag) + ($.definition (/.Builder @ tag) "A builder for finter tree structures.") - ($.documentation /.builder + ($.definition /.builder "A new builder using the given monoid." [(builder monoid)]) - ($.documentation /.value + ($.definition /.value "" [(value tree)]) - ($.documentation /.tags + ($.definition /.tags "" [(tags tree)]) - ($.documentation /.values + ($.definition /.values "" [(values tree)]) - ($.documentation /.one + ($.definition /.one "Finds one value that meets the predicate." [(one predicate tree)]) - ($.documentation /.exists? + ($.definition /.exists? "Verifies that a value exists which meets the predicate." [(exists? predicate tree)])] [])) diff --git a/stdlib/source/documentation/lux/data/collection/tree/zipper.lux b/stdlib/source/documentation/lux/data/collection/tree/zipper.lux index 317fd95ac..28535dac0 100644 --- a/stdlib/source/documentation/lux/data/collection/tree/zipper.lux +++ b/stdlib/source/documentation/lux/data/collection/tree/zipper.lux @@ -36,22 +36,22 @@ ($.default /.functor) ($.default /.comonad) - ($.documentation (/.Zipper it) + ($.definition (/.Zipper it) "Tree zippers, for easy navigation and editing of trees.") - ($.documentation /.set + ($.definition /.set "" [(set value zipper)]) - ($.documentation /.update + ($.definition /.update "" [(update transform zipper)]) - ($.documentation /.interpose + ($.definition /.interpose "" [(interpose value zipper)]) - ($.documentation /.adopt + ($.definition /.adopt "" [(adopt value zipper)])] [])) diff --git a/stdlib/source/documentation/lux/data/color.lux b/stdlib/source/documentation/lux/data/color.lux index 20ef0c572..32d48672f 100644 --- a/stdlib/source/documentation/lux/data/color.lux +++ b/stdlib/source/documentation/lux/data/color.lux @@ -46,54 +46,54 @@ ($.default /.saturated) ($.default /.un_saturated) - ($.documentation /.RGB + ($.definition /.RGB "Red-Green-Blue color format.") - ($.documentation /.HSL + ($.definition /.HSL "Hue-Saturation-Lightness color format.") - ($.documentation /.CMYK + ($.definition /.CMYK "Cyan-Magenta-Yellow-Key color format.") - ($.documentation /.HSB + ($.definition /.HSB "Hue-Saturation-Brightness color format.") - ($.documentation /.Color + ($.definition /.Color "A color value, independent of color format.") - ($.documentation /.complement + ($.definition /.complement "The opposite color." [(complement color)]) - ($.documentation /.interpolated + ($.definition /.interpolated "" [(interpolated ratio end start)]) - ($.documentation /.analogous + ($.definition /.analogous (palette_documentation /.analogous) [(analogous spread variations color)]) - ($.documentation /.monochromatic + ($.definition /.monochromatic (palette_documentation /.monochromatic) [(monochromatic spread variations color)]) - ($.documentation /.Alpha + ($.definition /.Alpha "The degree of transparency of a pigment.") - ($.documentation /.transparent + ($.definition /.transparent "The maximum degree of transparency.") - ($.documentation /.translucent + ($.definition /.translucent "The average degree of transparency.") - ($.documentation /.opaque + ($.definition /.opaque "The minimum degree of transparency.") - ($.documentation /.Pigment + ($.definition /.Pigment "A color with some degree of transparency.") (,, (with_template [<name>] - [(`` ($.documentation <name> + [(`` ($.definition <name> (format "A " (text.replaced "_" "-" (,, (template.text [<name>]))) " color scheme.")))] diff --git a/stdlib/source/documentation/lux/data/color/named.lux b/stdlib/source/documentation/lux/data/color/named.lux index f7da245b1..239281ab1 100644 --- a/stdlib/source/documentation/lux/data/color/named.lux +++ b/stdlib/source/documentation/lux/data/color/named.lux @@ -17,7 +17,7 @@ ($.module /._ "" [(,, (with_template [<name>] - [($.documentation <name> + [($.definition <name> (let [[red green blue] (//.rgb <name>) [_ name] (symbol <name>)] (format "R:" (hex#encoded red) diff --git a/stdlib/source/documentation/lux/data/format/json.lux b/stdlib/source/documentation/lux/data/format/json.lux index d263a0dfa..3670951f3 100644 --- a/stdlib/source/documentation/lux/data/format/json.lux +++ b/stdlib/source/documentation/lux/data/format/json.lux @@ -21,19 +21,19 @@ ($.default \\parser.unexpected_value) ($.default \\parser.value_mismatch) - ($.documentation (\\parser.Parser it) + ($.definition (\\parser.Parser it) "A JSON parser.") - ($.documentation \\parser.result + ($.definition \\parser.result (format "Executes the parser against a JSON object." \n "Verifies that all of the JSON was consumed by the parser.") [(result parser json)]) - ($.documentation \\parser.any + ($.definition \\parser.any "Just returns the JSON input without applying any logic.") (,, (with_template [<name>] - [(`` ($.documentation <name> + [(`` ($.definition <name> (format "Reads a JSON value as " (,, (template.text [<name>])) ".")))] [\\parser.null] @@ -43,9 +43,9 @@ )) (,, (with_template [<test> <check> <read>] - [(`` ($.documentation <test> + [(`` ($.definition <test> (format "Asks whether a JSON value is a " (,, (template.text [<read>])) "."))) - (`` ($.documentation <check> + (`` ($.definition <check> (format "Ensures a JSON value is a " (,, (template.text [<read>])) ".")))] [\\parser.boolean? \\parser.this_boolean ..boolean] @@ -53,25 +53,25 @@ [\\parser.string? \\parser.this_string ..string] )) - ($.documentation \\parser.nullable + ($.definition \\parser.nullable "Enhances parser by adding NULL-handling." [(nullable parser)]) - ($.documentation \\parser.array + ($.definition \\parser.array "Parses the contents of a JSON array." [(array parser)]) - ($.documentation \\parser.object + ($.definition \\parser.object (format "Parses the contents of a JSON object." \n "Use this with the 'field' combinator.") [(object parser)]) - ($.documentation \\parser.field + ($.definition \\parser.field (format "Parses a field inside a JSON object." \n "Use this inside the 'object' combinator.") [(field field_name parser)]) - ($.documentation \\parser.dictionary + ($.definition \\parser.dictionary "Parses a dictionary-like JSON object.")] []))) @@ -93,7 +93,7 @@ ($.default /.format) ($.default /.codec) - ($.documentation /.json + ($.definition /.json "A simple way to produce JSON literals." ["null" (json #null)] @@ -108,20 +108,20 @@ ["{'this' 'is', 'an' 'object'}" (json {"this" "is" "an" "object"})]) - ($.documentation /.fields + ($.definition /.fields "Get all the fields in a JSON object." [(fields json)]) - ($.documentation /.field + ($.definition /.field "A JSON object field getter." [(field key json)]) - ($.documentation /.has + ($.definition /.has "A JSON object field setter." [(has key value json)]) (,, (with_template [<name> <desc>] - [($.documentation <name> + [($.definition <name> (format "A JSON object field getter for " <desc> "."))] [/.boolean_field "booleans"] diff --git a/stdlib/source/documentation/lux/data/format/xml.lux b/stdlib/source/documentation/lux/data/format/xml.lux index 70f4855b0..2195db0c2 100644 --- a/stdlib/source/documentation/lux/data/format/xml.lux +++ b/stdlib/source/documentation/lux/data/format/xml.lux @@ -20,32 +20,32 @@ ($.default \\parser.unconsumed_inputs) ($.default \\parser.nowhere) - ($.documentation (\\parser.Parser it) + ($.definition (\\parser.Parser it) "A parser of XML-encoded data.") - ($.documentation \\parser.result + ($.definition \\parser.result (format "Applies a parser against a stream of XML documents." \n "Verifies that all of the inputs are consumed by the parser.") [(result parser documents)]) - ($.documentation \\parser.text + ($.definition \\parser.text "Yields text from a text node.") - ($.documentation \\parser.tag + ($.definition \\parser.tag "Yields the tag from the next node.") - ($.documentation \\parser.attribute + ($.definition \\parser.attribute "Yields the value of an attribute in the current node." [(attribute name)]) - ($.documentation \\parser.node + ($.definition \\parser.node "Parses the contents of the next node if the tag matches." [(node expected parser)]) - ($.documentation \\parser.any + ($.definition \\parser.any "Yields the next node.") - ($.documentation \\parser.somewhere + ($.definition \\parser.somewhere "Applies the parser somewhere among the remaining inputs; instead of demanding that the parser succeeds against the immediate inputs." [(somewhere parser)])] [])) @@ -61,13 +61,13 @@ ($.default /.codec) ($.default /.equivalence) - ($.documentation /.attributes + ($.definition /.attributes "An empty set of XML attributes.") - ($.documentation /.tag + ($.definition /.tag "The text format of a XML tag." [(tag name)]) - ($.documentation /.attribute + ($.definition /.attribute "The text format of a XML attribute.")] [..\\parser])) diff --git a/stdlib/source/documentation/lux/data/identity.lux b/stdlib/source/documentation/lux/data/identity.lux index e1d42389e..bdfa6dbd6 100644 --- a/stdlib/source/documentation/lux/data/identity.lux +++ b/stdlib/source/documentation/lux/data/identity.lux @@ -17,6 +17,6 @@ ($.default /.monad) ($.default /.comonad) - ($.documentation (/.Identity it) + ($.definition (/.Identity it) "A value, as is, without any extra structure super-imposed on it.")] [])) diff --git a/stdlib/source/documentation/lux/data/product.lux b/stdlib/source/documentation/lux/data/product.lux index 7275ad4ee..aad2b2f31 100644 --- a/stdlib/source/documentation/lux/data/product.lux +++ b/stdlib/source/documentation/lux/data/product.lux @@ -15,29 +15,29 @@ [($.default /.equivalence) ($.default /.hash) - ($.documentation /.left + ($.definition /.left "The left side of a pair.") - ($.documentation /.right + ($.definition /.right "The right side of a pair.") - ($.documentation /.curried + ($.definition /.curried "Converts a 2-argument function into nested single-argument functions." [(curried f)]) - ($.documentation /.uncurried + ($.definition /.uncurried "Converts nested single-argument functions into a 2-argument function." [(uncurried f)]) - ($.documentation /.swapped + ($.definition /.swapped "" [(swapped [left right])]) - ($.documentation /.then + ($.definition /.then "Apply functions to both sides of a pair." [(then f g)]) - ($.documentation /.forked + ($.definition /.forked "Yields a pair by applying both functions to a single value." [(forked f g)])] [])) diff --git a/stdlib/source/documentation/lux/data/sum.lux b/stdlib/source/documentation/lux/data/sum.lux index 2bd740509..19595cc10 100644 --- a/stdlib/source/documentation/lux/data/sum.lux +++ b/stdlib/source/documentation/lux/data/sum.lux @@ -18,17 +18,17 @@ ($.default /.equivalence) ($.default /.hash) - ($.documentation /.left + ($.definition /.left "Lifts value to the left side of a 2-variant.") - ($.documentation /.right + ($.definition /.right "Lifts value to the right side of a 2-variant.") - ($.documentation /.either + ($.definition /.either "Applies a function to either side of a 2-variant." [(either on_left on_right)]) - ($.documentation /.then + ($.definition /.then "Applies functions to both sides of a 2-variant." [(then on_left on_right)])] [])) diff --git a/stdlib/source/documentation/lux/data/text.lux b/stdlib/source/documentation/lux/data/text.lux index 03023fcc1..e783b5ee7 100644 --- a/stdlib/source/documentation/lux/data/text.lux +++ b/stdlib/source/documentation/lux/data/text.lux @@ -66,10 +66,10 @@ ($.default \\format.list) ($.default \\format.maybe) - ($.documentation (\\format.Format it) + ($.definition (\\format.Format it) "A way to produce readable text from values.") - ($.documentation \\format.format + ($.definition \\format.format "Text interpolation." [(format "Static part " (text static) " does not match URI: " uri)])] [])) @@ -87,56 +87,56 @@ ($.default \\parser.character_should_not_be) ($.default \\parser.character_does_not_satisfy_predicate) - ($.documentation \\parser.Offset + ($.definition \\parser.Offset "An offset into a block of text.") - ($.documentation (\\parser.Parser it) + ($.definition (\\parser.Parser it) "A parser for text.") - ($.documentation \\parser.Slice + ($.definition \\parser.Slice "A slice of a block of text.") - ($.documentation \\parser.result + ($.definition \\parser.result (format "Executes a parser against a block of text." \n "Verifies that the entire input has been processed.") [(result parser input)]) - ($.documentation \\parser.offset + ($.definition \\parser.offset "Yields the current offset into the input.") - ($.documentation \\parser.any + ($.definition \\parser.any "Yields the next character without applying any logic.") - ($.documentation \\parser.any! + ($.definition \\parser.any! "Yields the next character (as a slice) without applying any logic.") (,, (with_template [<name> <caveat>] - [(`` ($.documentation <name> + [(`` ($.definition <name> (format "Produce a character" (,, (template.text [<caveat>])) " if the parser fails.")))] [\\parser.not ""] [\\parser.not! " (as a slice)"] )) - ($.documentation \\parser.this + ($.definition \\parser.this "Checks that a specific text shows up in the input." [(this reference)]) - ($.documentation \\parser.end + ($.definition \\parser.end "Ensure the parser's input is empty.") - ($.documentation \\parser.next + ($.definition \\parser.next "Yields the next character (without consuming it from the input).") - ($.documentation \\parser.remaining + ($.definition \\parser.remaining "Get all of the remaining input (without consuming it).") - ($.documentation \\parser.range + ($.definition \\parser.range "Only yields characters within a range." [(range bottom top)]) (,, (with_template [<name> <desc>] - [($.documentation <name> + [($.definition <name> (format "Only yields " <desc> " characters."))] [\\parser.upper "uppercase"] @@ -145,17 +145,17 @@ [\\parser.octal "octal"] )) - ($.documentation \\parser.alpha + ($.definition \\parser.alpha "Yields alphabetic characters.") - ($.documentation \\parser.alpha_num + ($.definition \\parser.alpha_num "Yields alphanumeric characters.") - ($.documentation \\parser.hexadecimal + ($.definition \\parser.hexadecimal "Yields hexadecimal digits.") (,, (with_template [<name> <description_modifier>] - [($.documentation <name> + [($.definition <name> (format "Yields characters that are" <description_modifier> " part of a piece of text."))] [\\parser.one_of ""] @@ -163,32 +163,32 @@ )) (,, (with_template [<name> <description_modifier>] - [($.documentation <name> + [($.definition <name> (format "Yields characters (as a slice) that are" <description_modifier> " part of a piece of text."))] [\\parser.one_of! ""] [\\parser.none_of! " not"] )) - ($.documentation \\parser.satisfies + ($.definition \\parser.satisfies "Yields characters that satisfy a predicate." [(satisfies parser)]) - ($.documentation \\parser.space + ($.definition \\parser.space "Yields white-space.") - ($.documentation \\parser.and + ($.definition \\parser.and "Yields the outputs of both parsers composed together." [(and left right)]) - ($.documentation \\parser.and! + ($.definition \\parser.and! "Yields the outputs of both parsers composed together (as a slice)." [(and! left right)]) (,, (with_template [<text> <slice>] - [(`` ($.documentation <text> + [(`` ($.definition <text> (format "Yields " (,, (template.text [<name>])) " characters as a single continuous text."))) - (`` ($.documentation <slice> + (`` ($.definition <slice> (format "Yields " (,, (template.text [<name>])) " characters as a single continuous text (as a slice).")))] [\\parser.some \\parser.some!] @@ -196,9 +196,9 @@ )) (,, (with_template [<text> <slice> <doc_modifier>] - [(`` ($.documentation <text> + [(`` ($.definition <text> (format "Yields " <doc_modifier> " N characters."))) - (`` ($.documentation <slice> + (`` ($.definition <slice> (format "Yields " <doc_modifier> " N characters (as a slice).")))] [\\parser.exactly \\parser.exactly! "exactly"] @@ -206,27 +206,27 @@ [\\parser.at_least \\parser.at_least! "at least"] )) - ($.documentation \\parser.between + ($.definition \\parser.between "" [(between minimum additional parser)]) - ($.documentation \\parser.between! + ($.definition \\parser.between! "" [(between! minimum additional parser)]) - ($.documentation \\parser.enclosed + ($.definition \\parser.enclosed "" [(enclosed [start end] parser)]) - ($.documentation \\parser.local + ($.definition \\parser.local "Applies a parser against the given input." [(local local_input parser)]) - ($.documentation \\parser.slice + ($.definition \\parser.slice "Converts a slice to a block of text." [(slice parser)]) - ($.documentation \\parser.then + ($.definition \\parser.then "Embeds a text parser into an arbitrary parser that yields text." [(then structured text)])] []))) @@ -268,93 +268,93 @@ ($.default /.lower_cased) ($.default /.upper_cased) - ($.documentation /.Char + ($.definition /.Char "A character code number.") - ($.documentation /.line_feed + ($.definition /.line_feed "Same as 'new_line'.") - ($.documentation /.char + ($.definition /.char "Yields the character at the specified index." [(char index input)]) - ($.documentation /.index_since + ($.definition /.index_since "" [(index_since from pattern input)]) - ($.documentation /.index + ($.definition /.index "" [(index pattern input)]) - ($.documentation /.last_index + ($.definition /.last_index "" [(last_index part text)]) - ($.documentation /.starts_with? + ($.definition /.starts_with? "" [(starts_with? prefix x)]) - ($.documentation /.ends_with? + ($.definition /.ends_with? "" [(ends_with? postfix x)]) - ($.documentation /.enclosed_by? + ($.definition /.enclosed_by? "" [(enclosed_by? boundary value)]) - ($.documentation /.contains? + ($.definition /.contains? "" [(contains? sub text)]) - ($.documentation /.prefix + ($.definition /.prefix "" [(prefix param subject)]) - ($.documentation /.suffix + ($.definition /.suffix "" [(suffix param subject)]) - ($.documentation /.enclosed + ($.definition /.enclosed "Surrounds the given content text with left and right side additions." [(enclosed [left right] content)]) - ($.documentation /.enclosed' + ($.definition /.enclosed' "Surrounds the given content text with the same boundary text." [(enclosed' boundary content)]) - ($.documentation /.clip + ($.definition /.clip "Clips a chunk of text from the input at the specified offset and of the specified size." [(clip offset size input)]) - ($.documentation /.clip_since + ($.definition /.clip_since "Clips the remaining text from the input at the specified offset." [(clip_since offset input)]) - ($.documentation /.split_at + ($.definition /.split_at "" [(split_at at x)]) - ($.documentation /.split_by + ($.definition /.split_by "" [(split_by token sample)]) - ($.documentation /.all_split_by + ($.definition /.all_split_by "" [(all_split_by token sample)]) - ($.documentation /.replaced_once + ($.definition /.replaced_once "" [(replaced_once pattern replacement template)]) - ($.documentation /.replaced + ($.definition /.replaced "" [(replaced pattern replacement template)]) - ($.documentation /.interposed + ($.definition /.interposed "" [(interposed separator texts)]) - ($.documentation /.space? + ($.definition /.space? "Checks whether the character is white-space." [(space? char)])] [..\\format diff --git a/stdlib/source/documentation/lux/data/text/buffer.lux b/stdlib/source/documentation/lux/data/text/buffer.lux index 9f64dd787..38bd18830 100644 --- a/stdlib/source/documentation/lux/data/text/buffer.lux +++ b/stdlib/source/documentation/lux/data/text/buffer.lux @@ -17,6 +17,6 @@ ($.default /.size) ($.default /.text) - ($.documentation /.Buffer + ($.definition /.Buffer "Immutable text buffer for efficient text concatenation.")] [])) diff --git a/stdlib/source/documentation/lux/data/text/encoding.lux b/stdlib/source/documentation/lux/data/text/encoding.lux index 471b5970e..40366df2c 100644 --- a/stdlib/source/documentation/lux/data/text/encoding.lux +++ b/stdlib/source/documentation/lux/data/text/encoding.lux @@ -16,11 +16,11 @@ "" [($.default /.name) - ($.documentation /.Encoding + ($.definition /.Encoding "Encoding formats for text.") (,, (with_template [<name>] - [($.documentation <name> + [($.definition <name> (format "'" (/.name <name>) "' text encoding. "))] [/.ascii] diff --git a/stdlib/source/documentation/lux/data/text/encoding/utf8.lux b/stdlib/source/documentation/lux/data/text/encoding/utf8.lux index eaa712caf..afe5d2b41 100644 --- a/stdlib/source/documentation/lux/data/text/encoding/utf8.lux +++ b/stdlib/source/documentation/lux/data/text/encoding/utf8.lux @@ -12,6 +12,6 @@ (.List $.Module) ($.module /._ "" - [($.documentation /.codec + [($.definition /.codec "A codec for binary encoding of text as UTF-8.")] [])) diff --git a/stdlib/source/documentation/lux/data/text/escape.lux b/stdlib/source/documentation/lux/data/text/escape.lux index aa0ec4015..25081c655 100644 --- a/stdlib/source/documentation/lux/data/text/escape.lux +++ b/stdlib/source/documentation/lux/data/text/escape.lux @@ -17,16 +17,16 @@ ($.default /.invalid_escape) ($.default /.invalid_unicode_escape) - ($.documentation /.escaped + ($.definition /.escaped "Yields a escaped version of the text." [(escaped text)]) - ($.documentation /.un_escaped + ($.definition /.un_escaped (format "Yields an un-escaped text." \n "Fails if it was improperly escaped.") [(un_escaped text)]) - ($.documentation /.literal + ($.definition /.literal "If given a escaped text literal, expands to an un-escaped version." [(/.literal "Line 1\nLine 2") "=>" diff --git a/stdlib/source/documentation/lux/data/text/regex.lux b/stdlib/source/documentation/lux/data/text/regex.lux index fef504012..b939df37d 100644 --- a/stdlib/source/documentation/lux/data/text/regex.lux +++ b/stdlib/source/documentation/lux/data/text/regex.lux @@ -14,7 +14,7 @@ "" [($.default /.incorrect_quantification) - ($.documentation /.regex + ($.definition /.regex "Create lexers using regular-expression syntax." ["Literals" (regex "a")] @@ -60,7 +60,7 @@ (regex "a|b") (regex "a(.)(.)|b(.)(.)")]) - ($.documentation /.pattern + ($.definition /.pattern "Allows you to test text against regular expressions." [(case some_text (pattern "(\d{3})-(\d{3})-(\d{4})" diff --git a/stdlib/source/documentation/lux/data/text/unicode/block.lux b/stdlib/source/documentation/lux/data/text/unicode/block.lux index d23c6815d..72f45cdaa 100644 --- a/stdlib/source/documentation/lux/data/text/unicode/block.lux +++ b/stdlib/source/documentation/lux/data/text/unicode/block.lux @@ -22,19 +22,19 @@ ($.default /.equivalence) ($.default /.hash) - ($.documentation /.Block + ($.definition /.Block "A block of valid unicode characters.") - ($.documentation /.block + ($.definition /.block "" [(block start additional)]) - ($.documentation /.within? + ($.definition /.within? "" [(within? block char)]) (,, (with_template [<name>] - [($.documentation <name> + [($.definition <name> (let [[_ name] (symbol <name>)] (format (hex#encoded (/.start <name>)) "-" (hex#encoded (/.end <name>)) diff --git a/stdlib/source/documentation/lux/data/text/unicode/set.lux b/stdlib/source/documentation/lux/data/text/unicode/set.lux index 1e637cf5e..57040bb69 100644 --- a/stdlib/source/documentation/lux/data/text/unicode/set.lux +++ b/stdlib/source/documentation/lux/data/text/unicode/set.lux @@ -28,11 +28,11 @@ ($.default /.upper_case) ($.default /.lower_case) - ($.documentation /.set + ($.definition /.set "" [(set [head tail])]) - ($.documentation /.member? + ($.definition /.member? "" [(member? set character)])] [])) |