diff options
Diffstat (limited to '')
| -rw-r--r-- | stdlib/source/documentation/lux/world/file.lux | 87 |
1 files changed, 39 insertions, 48 deletions
diff --git a/stdlib/source/documentation/lux/world/file.lux b/stdlib/source/documentation/lux/world/file.lux index 753ebd8ea..3ae7449e6 100644 --- a/stdlib/source/documentation/lux/world/file.lux +++ b/stdlib/source/documentation/lux/world/file.lux @@ -1,7 +1,7 @@ (.require [library [lux (.except) - ["$" documentation (.only documentation:)] + ["$" documentation] ["@" target] [data ["[0]" text (.only \n) @@ -13,61 +13,52 @@ ["[0]" / ["[1][0]" watch]]) -(documentation: /.Path - "A path to a file or a directory in a file-system.") - -(documentation: (/.System !) - "An interface to a file-system.") - -(documentation: /.parent - "If a path represents a nested file/directory, extracts its parent directory." - [(parent fs path)]) - -(documentation: /.name - "The un-nested name of a file/directory." - [(name fs path)]) - -(documentation: /.rooted - "A nested path for a file/directory, given a root/parent path and a file/directory name within it." - [(rooted fs parent child)]) - -(documentation: /.exists? - "Checks if either a file or a directory exists at the given path." - [(exists? monad fs path)]) - -(documentation: /.mock - (format "A purely in-memory simulation of a file-system." - \n "Useful for testing.") - [(mock separator)]) - -(documentation: /.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)]) - -(documentation: /.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)]) - (.def .public documentation (.List $.Module) (`` (`` ($.module /._ "" - [..Path - ..System - ..parent - ..name - ..rooted - ..exists? - ..mock - ..make_directories - ..make_file - ($.default /.async) + [($.default /.async) ($.default /.cannot_make_file) ($.default /.cannot_find_file) ($.default /.cannot_delete) ($.default /.cannot_make_directory) ($.default /.cannot_find_directory) (~~ (for @.lua (~~ (these)) - (~~ (these ($.default /.default)))))] + (~~ (these ($.default /.default))))) + + ($.documentation /.Path + "A path to a file or a directory in a file-system.") + + ($.documentation (/.System !) + "An interface to a file-system.") + + ($.documentation /.parent + "If a path represents a nested file/directory, extracts its parent directory." + [(parent fs path)]) + + ($.documentation /.name + "The un-nested name of a file/directory." + [(name fs path)]) + + ($.documentation /.rooted + "A nested path for a file/directory, given a root/parent path and a file/directory name within it." + [(rooted fs parent child)]) + + ($.documentation /.exists? + "Checks if either a file or a directory exists at the given path." + [(exists? monad fs path)]) + + ($.documentation /.mock + (format "A purely in-memory simulation of a file-system." + \n "Useful for testing.") + [(mock separator)]) + + ($.documentation /.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)]) + + ($.documentation /.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)])] [/watch.documentation])))) |