aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/library/lux/world/shell.lux
diff options
context:
space:
mode:
authorEduardo Julian2021-08-12 03:12:42 -0400
committerEduardo Julian2021-08-12 03:12:42 -0400
commit17629d66062b88b040a2397032f6c08361a5f3a7 (patch)
treebdc6110750b895667b9e45da5e46bec9609f9a7c /stdlib/source/library/lux/world/shell.lux
parenta62ce3f9c2b605e0033f4772b0f64c4525de4d86 (diff)
Improved binding syntax for "syntax:".
Diffstat (limited to 'stdlib/source/library/lux/world/shell.lux')
-rw-r--r--stdlib/source/library/lux/world/shell.lux9
1 files changed, 9 insertions, 0 deletions
diff --git a/stdlib/source/library/lux/world/shell.lux b/stdlib/source/library/lux/world/shell.lux
index a09be98bb..429c46897 100644
--- a/stdlib/source/library/lux/world/shell.lux
+++ b/stdlib/source/library/lux/world/shell.lux
@@ -34,6 +34,7 @@
[file (#+ Path)]])
(type: .public Exit
+ {#.doc (example "A program exit code.")}
Int)
(template [<code> <name>]
@@ -46,6 +47,8 @@
)
(interface: .public (Process !)
+ {#.doc (example "The means for communicating with a program/process being executed by the operating system.")}
+
(: (-> [] (! (Try Text)))
read)
(: (-> [] (! (Try Text)))
@@ -73,12 +76,16 @@
)))))
(type: .public Command
+ {#.doc (example "A command that can be executed by the operating system.")}
Text)
(type: .public Argument
+ {#.doc (example "A parameter for a command.")}
Text)
(interface: .public (Shell !)
+ {#.doc (example "The means for issuing commands to the operating system.")}
+
(: (-> [Environment Path Command (List Argument)] (! (Try (Process !))))
execute))
@@ -307,6 +314,8 @@
(as_is)))
(interface: .public (Mock s)
+ {#.doc (example "A simulated process.")}
+
(: (-> s (Try [s Text]))
on_read)
(: (-> s (Try [s Text]))