diff options
Diffstat (limited to '')
| -rw-r--r-- | stdlib/source/documentation/lux/data/text.lux | 116 |
1 files changed, 58 insertions, 58 deletions
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 |