aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/library/lux/control/parser/environment.lux
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--stdlib/source/library/lux/control/parser/environment.lux14
1 files changed, 7 insertions, 7 deletions
diff --git a/stdlib/source/library/lux/control/parser/environment.lux b/stdlib/source/library/lux/control/parser/environment.lux
index b83ef9165..5358da9ca 100644
--- a/stdlib/source/library/lux/control/parser/environment.lux
+++ b/stdlib/source/library/lux/control/parser/environment.lux
@@ -13,11 +13,11 @@
["." //])
(type: .public Property
- {#.doc (doc "A property in the environment.")}
+ {#.doc (example "A property in the environment.")}
Text)
(type: .public Environment
- {#.doc (doc "An abstraction for environment variables of a program.")}
+ {#.doc (example "An abstraction for environment variables of a program.")}
(Dictionary Property Text))
(exception: .public (unknown_property {property Property})
@@ -25,11 +25,11 @@
["Property" (%.text property)]))
(type: .public (Parser a)
- {#.doc (doc "A parser of environment variables of a program.")}
+ {#.doc (example "A parser of environment variables of a program.")}
(//.Parser Environment a))
(def: .public empty
- {#.doc (doc "An empty environment.")}
+ {#.doc (example "An empty environment.")}
Environment
(dictionary.empty text.hash))
@@ -43,8 +43,8 @@
#.None
(exception.except ..unknown_property [name]))))
-(def: .public (run parser environment)
- {#.doc (doc "Executes a parser against the given environment variables."
- "Does not check whether all environment variables were parsed, since they're usually an open set.")}
+(def: .public (result parser environment)
+ {#.doc (example "Executes a parser against the given environment variables."
+ "Does not check whether all environment variables were parsed, since they're usually an open set.")}
(All [a] (-> (Parser a) Environment (Try a)))
(\ try.monad map product.right (parser environment)))