aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/world/file.lux
diff options
context:
space:
mode:
Diffstat (limited to 'stdlib/source/documentation/lux/world/file.lux')
-rw-r--r--stdlib/source/documentation/lux/world/file.lux14
1 files changed, 7 insertions, 7 deletions
diff --git a/stdlib/source/documentation/lux/world/file.lux b/stdlib/source/documentation/lux/world/file.lux
index d5df3bca6..ec5999640 100644
--- a/stdlib/source/documentation/lux/world/file.lux
+++ b/stdlib/source/documentation/lux/world/file.lux
@@ -36,33 +36,33 @@
($.definition /.parent
"If a path represents a nested file/directory, extracts its parent directory."
- [(parent fs path)])
+ ($.example (parent fs path)))
($.definition /.name
"The un-nested name of a file/directory."
- [(name fs path)])
+ ($.example (name fs path)))
($.definition /.rooted
"A nested path for a file/directory, given a root/parent path and a file/directory name within it."
- [(rooted fs parent child)])
+ ($.example (rooted fs parent child)))
($.definition /.exists?
"Checks if either a file or a directory exists at the given path."
- [(exists? monad fs path)])
+ ($.example (exists? monad fs path)))
($.definition /.mock
(format "A purely in-memory simulation of a file-system."
\n "Useful for testing.")
- [(mock separator)])
+ ($.example (mock separator)))
($.definition /.make_directories
(format "Creates the directory specified by the given path."
\n "Also, creates every super-directory necessary to make the given path valid.")
- [(make_directories monad fs path)])
+ ($.example (make_directories monad fs path)))
($.definition /.make_file
"Creates a new file with the given content if-and-only-if the file does not already exist."
- [(make_file monad fs content path)])
+ ($.example (make_file monad fs content path)))
/watch.documentation
))))