aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/world/environment.lux
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--stdlib/source/documentation/lux/world/environment.lux31
1 files changed, 30 insertions, 1 deletions
diff --git a/stdlib/source/documentation/lux/world/environment.lux b/stdlib/source/documentation/lux/world/environment.lux
index 6f842b4b9..4703069ed 100644
--- a/stdlib/source/documentation/lux/world/environment.lux
+++ b/stdlib/source/documentation/lux/world/environment.lux
@@ -5,9 +5,38 @@
[data
["[0]" text (.only \n)
["%" \\format (.only format)]]]]]
+ ["[0]" \\parser]
[\\library
["[0]" /]])
+(.def \\parser
+ (.List $.Module)
+ ($.module \\parser._
+ ""
+ [($.default \\parser.unknown_property)
+
+ ($.documentation \\parser.Property
+ "A property in the environment.")
+
+ ($.documentation \\parser.Environment
+ "An abstraction for environment variables of a program.")
+
+ ($.documentation (\\parser.Parser it)
+ "A parser of environment variables of a program.")
+
+ ($.documentation \\parser.empty
+ "An empty environment.")
+
+ ($.documentation \\parser.property
+ ""
+ [(property name)])
+
+ ($.documentation \\parser.result
+ (format "Executes a parser against the given environment variables."
+ \n "Does not check whether all environment variables were parsed, since they're usually an open set.")
+ [(result parser environment)])]
+ []))
+
(.def .public documentation
(.List $.Module)
($.module /._
@@ -26,4 +55,4 @@
($.documentation /.mock
""
[(mock environment home directory)])]
- []))
+ [..\\parser]))