diff options
Diffstat (limited to 'stdlib/source/library/lux/documentation.lux')
| -rw-r--r-- | stdlib/source/library/lux/documentation.lux | 104 |
1 files changed, 52 insertions, 52 deletions
diff --git a/stdlib/source/library/lux/documentation.lux b/stdlib/source/library/lux/documentation.lux index 2e2b7e65e..676746bd5 100644 --- a/stdlib/source/library/lux/documentation.lux +++ b/stdlib/source/library/lux/documentation.lux @@ -1,38 +1,38 @@ (.using - [library - [lux {"-" Definition Module type} - ["[0]" meta] - ["[0]" type ("[1]#[0]" equivalence)] - [abstract - [monad {"+" do}] - ["[0]" enum]] - [control - ["[0]" maybe ("[1]#[0]" functor)] - ["[0]" exception {"+" exception:}] - ["<>" parser ("[1]#[0]" monad) - ["<[0]>" code {"+" Parser}]]] - [data - ["[0]" product] - ["[0]" text {"+" \n} ("[1]#[0]" order) - ["%" format {"+" format}]] - [collection - ["[0]" list ("[1]#[0]" monad mix monoid)] - ["[0]" set {"+" Set}] - ["[0]" stream {"+" Stream}]] - [format - ["md" markdown {"+" Markdown Block}]]] - ["[0]" macro - [syntax {"+" syntax:}] - ["[0]" code] - ["[0]" template]] - [math - [number - ["n" nat]]] - [tool - [compiler - [language - [lux - ["[0]" syntax]]]]]]]) + [library + [lux {"-" Definition Module type} + ["[0]" meta] + ["[0]" type ("[1]#[0]" equivalence)] + [abstract + [monad {"+" do}] + ["[0]" enum]] + [control + ["[0]" maybe ("[1]#[0]" functor)] + ["[0]" exception {"+" exception:}] + ["<>" parser ("[1]#[0]" monad) + ["<[0]>" code {"+" Parser}]]] + [data + ["[0]" product] + ["[0]" text {"+" \n} ("[1]#[0]" order) + ["%" format {"+" format}]] + [collection + ["[0]" list ("[1]#[0]" monad mix monoid)] + ["[0]" set {"+" Set}] + ["[0]" stream {"+" Stream}]] + [format + ["md" markdown {"+" Markdown Block}]]] + ["[0]" macro + [syntax {"+" syntax:}] + ["[0]" code] + ["[0]" template]] + [math + [number + ["n" nat]]] + [tool + [compiler + [language + [lux + ["[0]" syntax]]]]]]]) (template: (|recursion_dummy|) [{.#Primitive "" {.#End}}]) @@ -96,14 +96,14 @@ ... else (%.symbol [module short]))] - [(revised@ .#column (n.+ (text.size documentation)) new_location) + [(revised .#column (n.+ (text.size documentation)) new_location) (format (padding reference_column old_location new_location) documentation)]) (^template [<tag> <format>] [[new_location {<tag> value}] (let [documentation (`` (|> value (~~ (template.spliced <format>))))] - [(revised@ .#column (n.+ (text.size documentation)) new_location) + [(revised .#column (n.+ (text.size documentation)) new_location) (format (padding reference_column old_location new_location) documentation)])]) ([.#Bit [%.bit]] @@ -118,9 +118,9 @@ (let [[group_location' members_documentation] (list#mix (function (_ part [last_location text_accum]) (let [[member_location member_documentation] (code_documentation expected_module last_location reference_column part)] [member_location (format text_accum member_documentation)])) - [(revised@ .#column ++ group_location) ""] + [(revised .#column ++ group_location) ""] members)] - [(revised@ .#column ++ group_location') + [(revised .#column ++ group_location') (format (padding reference_column old_location group_location) |<| members_documentation |>|)])]) ([syntax.open_form syntax.close_form .#Form] @@ -146,7 +146,7 @@ (let [reference_column (..reference_column example) [location _] example] (|> example - (..code_documentation module (with@ .#column reference_column location) reference_column) + (..code_documentation module (has .#column reference_column location) reference_column) product.right)))) (def: parameter_name_options "abcdefghijklmnopqrstuvwxyz") @@ -601,9 +601,9 @@ (def: definitions_documentation (-> (List Definition) (Markdown Block)) (|>> (list.sorted (function (_ left right) - (text#< (value@ #definition right) - (value@ #definition left)))) - (list#each (value@ #documentation)) + (text#< (the #definition right) + (the #definition left)))) + (list#each (the #documentation)) (list#mix md.then md.empty))) (def: expected_separator @@ -655,9 +655,9 @@ (let [(^open "_[0]") module] ($_ md.then ... Name - (md.heading/1 (value@ #module module)) + (md.heading/1 (the #module module)) ... Description - (case (value@ #description module) + (case (the #description module) "" md.empty description (<| md.paragraph md.text @@ -665,15 +665,15 @@ ... Definitions (md.heading/2 "Definitions") (|> module - (value@ #definitions) - (list.only (|>> (value@ #definition) + (the #definitions) + (list.only (|>> (the #definition) (set.member? _#expected))) ..definitions_documentation) ... Missing documentation (case (|> module - (value@ #definitions) + (the #definitions) (list#mix (function (_ definition missing) - (set.lacks (value@ #definition definition) missing)) + (set.lacks (the #definition definition) missing)) _#expected) set.list) {.#End} @@ -685,11 +685,11 @@ (..listing missing))) ... Un-expected documentation (case (|> module - (value@ #definitions) - (list.only (|>> (value@ #definition) + (the #definitions) + (list.only (|>> (the #definition) (set.member? _#expected) not)) - (list#each (value@ #definition))) + (list#each (the #definition))) {.#End} md.empty @@ -702,7 +702,7 @@ (def: .public documentation (-> (List Module) Text) (|>> (list.sorted (function (_ left right) - (text#< (value@ #module right) (value@ #module left)))) + (text#< (the #module right) (the #module left)))) (list#each ..module_documentation) (list.interposed md.horizontal_rule) (list#mix md.then (: (Markdown Block) md.empty)) |