diff options
Diffstat (limited to '')
21 files changed, 85 insertions, 85 deletions
diff --git a/stdlib/source/documentation/lux/world/console.lux b/stdlib/source/documentation/lux/world/console.lux index b2a2f1d15..01924beae 100644 --- a/stdlib/source/documentation/lux/world/console.lux +++ b/stdlib/source/documentation/lux/world/console.lux @@ -20,18 +20,18 @@ ($.default /.default))) (,, (these)))) - ($.documentation (/.Console !) + ($.definition (/.Console !) "An interface to console/terminal I/O.") - ($.documentation /.write_line + ($.definition /.write_line "Writes the message on the console and appends a new-line/line-feed at the end." [(write_line message console)]) - ($.documentation (/.Mock s) + ($.definition (/.Mock s) (format "A mock/simulation of a console." \n "Useful for testing.")) - ($.documentation /.mock + ($.definition /.mock "" [(mock mock init)])] [])))) diff --git a/stdlib/source/documentation/lux/world/environment.lux b/stdlib/source/documentation/lux/world/environment.lux index 4703069ed..d27256846 100644 --- a/stdlib/source/documentation/lux/world/environment.lux +++ b/stdlib/source/documentation/lux/world/environment.lux @@ -15,23 +15,23 @@ "" [($.default \\parser.unknown_property) - ($.documentation \\parser.Property + ($.definition \\parser.Property "A property in the environment.") - ($.documentation \\parser.Environment + ($.definition \\parser.Environment "An abstraction for environment variables of a program.") - ($.documentation (\\parser.Parser it) + ($.definition (\\parser.Parser it) "A parser of environment variables of a program.") - ($.documentation \\parser.empty + ($.definition \\parser.empty "An empty environment.") - ($.documentation \\parser.property + ($.definition \\parser.property "" [(property name)]) - ($.documentation \\parser.result + ($.definition \\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)])] @@ -45,14 +45,14 @@ ($.default /.async) ($.default /.default) - ($.documentation (/.Environment !) + ($.definition (/.Environment !) "Access to ambient environment data and the capacity to exit the program.") - ($.documentation /.environment + ($.definition /.environment "Assembles the environment variables available to the program." [(environment monad program)]) - ($.documentation /.mock + ($.definition /.mock "" [(mock environment home directory)])] [..\\parser])) diff --git a/stdlib/source/documentation/lux/world/file.lux b/stdlib/source/documentation/lux/world/file.lux index 04ba576a5..97a8b0966 100644 --- a/stdlib/source/documentation/lux/world/file.lux +++ b/stdlib/source/documentation/lux/world/file.lux @@ -25,39 +25,39 @@ (,, (for @.lua (,, (these)) (,, (these ($.default /.default))))) - ($.documentation /.Path + ($.definition /.Path "A path to a file or a directory in a file-system.") - ($.documentation (/.System !) + ($.definition (/.System !) "An interface to a file-system.") - ($.documentation /.parent + ($.definition /.parent "If a path represents a nested file/directory, extracts its parent directory." [(parent fs path)]) - ($.documentation /.name + ($.definition /.name "The un-nested name of a file/directory." [(name fs path)]) - ($.documentation /.rooted + ($.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)]) - ($.documentation /.exists? + ($.definition /.exists? "Checks if either a file or a directory exists at the given path." [(exists? monad fs path)]) - ($.documentation /.mock + ($.definition /.mock (format "A purely in-memory simulation of a file-system." \n "Useful for testing.") [(mock separator)]) - ($.documentation /.make_directories + ($.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)]) - ($.documentation /.make_file + ($.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)])] [/watch.documentation])))) diff --git a/stdlib/source/documentation/lux/world/file/watch.lux b/stdlib/source/documentation/lux/world/file/watch.lux index 75ca237dd..b1f441915 100644 --- a/stdlib/source/documentation/lux/world/file/watch.lux +++ b/stdlib/source/documentation/lux/world/file/watch.lux @@ -24,27 +24,27 @@ ($.default /.not_being_watched) ($.default /.cannot_poll_a_non_existent_directory) - ($.documentation /.Concern + ($.definition /.Concern "A particular concern to watch-out for.") - ($.documentation /.and + ($.definition /.and "" [(and left right)]) - ($.documentation (/.Watcher !) + ($.definition (/.Watcher !) "Machinery for watching a file-system for changes to files and directories.") - ($.documentation /.polling + ($.definition /.polling (format "A simple watcher that works for any file-system." "Polls files and directories to detect changes.") [(polling fs)]) - ($.documentation /.mock + ($.definition /.mock (format "A fake/emulated watcher." \n "Must be given a path separator for the file-system.") [(mock separator)]) - (,, (for @.jvm (,, (these ($.documentation /.default + (,, (for @.jvm (,, (these ($.definition /.default "The default watcher for the default file-system."))) (,, (these))))] [])))) diff --git a/stdlib/source/documentation/lux/world/input/keyboard.lux b/stdlib/source/documentation/lux/world/input/keyboard.lux index 148cb708b..be9db67b1 100644 --- a/stdlib/source/documentation/lux/world/input/keyboard.lux +++ b/stdlib/source/documentation/lux/world/input/keyboard.lux @@ -97,9 +97,9 @@ ($.default /.release) ($.default /.press) - ($.documentation /.Key + ($.definition /.Key "A key from a keyboard, identify by a numeric ID.") - ($.documentation /.Press + ($.definition /.Press "A key-press for a key.")] [])) diff --git a/stdlib/source/documentation/lux/world/locale.lux b/stdlib/source/documentation/lux/world/locale.lux index b03601d73..1818dcfb2 100644 --- a/stdlib/source/documentation/lux/world/locale.lux +++ b/stdlib/source/documentation/lux/world/locale.lux @@ -21,10 +21,10 @@ ($.default /.hash) ($.default /.equivalence) - ($.documentation /.Locale + ($.definition /.Locale "A description of a locale; with territory, (optional) language, and (optional) text-encoding.") - ($.documentation /.locale + ($.definition /.locale "" [(locale language territory encoding)])] [/language.documentation diff --git a/stdlib/source/documentation/lux/world/locale/language.lux b/stdlib/source/documentation/lux/world/locale/language.lux index cc0f4e7be..a9d5f6ef6 100644 --- a/stdlib/source/documentation/lux/world/locale/language.lux +++ b/stdlib/source/documentation/lux/world/locale/language.lux @@ -654,6 +654,6 @@ ..items/y ..items/z - ($.documentation /.Language + ($.definition /.Language "An ISO 639 language.")] []))) diff --git a/stdlib/source/documentation/lux/world/locale/territory.lux b/stdlib/source/documentation/lux/world/locale/territory.lux index 232f18038..eab56ae6a 100644 --- a/stdlib/source/documentation/lux/world/locale/territory.lux +++ b/stdlib/source/documentation/lux/world/locale/territory.lux @@ -315,6 +315,6 @@ ..items/pqrs ..items/tuvwxyz - ($.documentation /.Territory + ($.definition /.Territory "An ISO 3166 territory.")] []))) diff --git a/stdlib/source/documentation/lux/world/net.lux b/stdlib/source/documentation/lux/world/net.lux index 5f309dcb4..f2e301d2f 100644 --- a/stdlib/source/documentation/lux/world/net.lux +++ b/stdlib/source/documentation/lux/world/net.lux @@ -20,13 +20,13 @@ "" [($.default /.Location) - ($.documentation /.Address + ($.definition /.Address "A TCP/IP address.") - ($.documentation /.Port + ($.definition /.Port "A TCP/IP port.") - ($.documentation /.URL + ($.definition /.URL "A Uniform Resource Locator.")] [/uri.documentation /http/client.documentation diff --git a/stdlib/source/documentation/lux/world/net/http/client.lux b/stdlib/source/documentation/lux/world/net/http/client.lux index fe77ae817..e5605d57c 100644 --- a/stdlib/source/documentation/lux/world/net/http/client.lux +++ b/stdlib/source/documentation/lux/world/net/http/client.lux @@ -21,11 +21,11 @@ (,, (for @.jvm (,, (these ($.default /.default))) (,, (these)))) - ($.documentation (/.Client !) + ($.definition (/.Client !) "A HTTP client capable of issuing requests to a HTTP server.") (,, (with_template [<name>] - [($.documentation <name> + [($.definition <name> (format "A " (text.upper_cased (template.text [<name>])) " request."))] [/.post] diff --git a/stdlib/source/documentation/lux/world/net/http/status.lux b/stdlib/source/documentation/lux/world/net/http/status.lux index 0e38a3e54..94b646d02 100644 --- a/stdlib/source/documentation/lux/world/net/http/status.lux +++ b/stdlib/source/documentation/lux/world/net/http/status.lux @@ -16,7 +16,7 @@ ($.module /._ "" [(,, (with_template [<name>] - [($.documentation <name> + [($.definition <name> (|> (template.text [<name>]) (text.replaced "_" " ") text.upper_cased diff --git a/stdlib/source/documentation/lux/world/net/uri.lux b/stdlib/source/documentation/lux/world/net/uri.lux index 64aadc1fd..ab808ab5f 100644 --- a/stdlib/source/documentation/lux/world/net/uri.lux +++ b/stdlib/source/documentation/lux/world/net/uri.lux @@ -13,9 +13,9 @@ (.List $.Module) ($.module /._ "" - [($.documentation /.URI + [($.definition /.URI "A Uniform Resource Identifier.") - ($.documentation /.separator + ($.definition /.separator "A separator for the pieces of a URI.")] [])) diff --git a/stdlib/source/documentation/lux/world/output/video/resolution.lux b/stdlib/source/documentation/lux/world/output/video/resolution.lux index 1a3652c74..a53ea1ff0 100644 --- a/stdlib/source/documentation/lux/world/output/video/resolution.lux +++ b/stdlib/source/documentation/lux/world/output/video/resolution.lux @@ -18,11 +18,11 @@ [($.default /.hash) ($.default /.equivalence) - ($.documentation /.Resolution + ($.definition /.Resolution "A screen resolution.") (,, (with_template [<name>] - [($.documentation <name> + [($.definition <name> (let [name (|> (template.text [<name>]) (text.replaced "_" " ") text.upper_cased)] diff --git a/stdlib/source/documentation/lux/world/shell.lux b/stdlib/source/documentation/lux/world/shell.lux index f551aa6ce..9bc4e1978 100644 --- a/stdlib/source/documentation/lux/world/shell.lux +++ b/stdlib/source/documentation/lux/world/shell.lux @@ -21,25 +21,25 @@ ($.default /.default))) (,, (these)))) - ($.documentation /.Exit + ($.definition /.Exit "A program exit code.") - ($.documentation (/.Process !) + ($.definition (/.Process !) "The means for communicating with a program/process being executed by the operating system.") - ($.documentation /.Command + ($.definition /.Command "A command that can be executed by the operating system.") - ($.documentation /.Argument + ($.definition /.Argument "A parameter for a command.") - ($.documentation (/.Shell !) + ($.definition (/.Shell !) "The means for issuing commands to the operating system.") - ($.documentation (/.Mock s) + ($.definition (/.Mock s) "A simulated process.") - ($.documentation /.mock + ($.definition /.mock "" [(mock mock init)])] [])))) diff --git a/stdlib/source/documentation/lux/world/time.lux b/stdlib/source/documentation/lux/world/time.lux index f327e942a..177b8b2f6 100644 --- a/stdlib/source/documentation/lux/world/time.lux +++ b/stdlib/source/documentation/lux/world/time.lux @@ -30,7 +30,7 @@ ($.default /.parser) (,, (with_template [<name> <doc>] - [($.documentation <name> + [($.definition <name> <doc>)] [/.milli_seconds "Number of milli-seconds in a second."] @@ -39,28 +39,28 @@ [/.hours "Number of hours in an day."] )) - ($.documentation /.Time + ($.definition /.Time "Time is defined as milliseconds since the start of the day (00:00:00.000).") - ($.documentation /.midnight + ($.definition /.midnight "The instant corresponding to the start of the day: 00:00:00.000") - ($.documentation /.of_millis + ($.definition /.of_millis "" [(of_millis milli_seconds)]) - ($.documentation /.Clock + ($.definition /.Clock "A clock marking the specific hour, minute, second, and milli-second in a day.") - ($.documentation /.clock + ($.definition /.clock "" [(clock time)]) - ($.documentation /.time + ($.definition /.time "" [(time clock)]) - ($.documentation /.codec + ($.definition /.codec (format "Based on ISO 8601." \n "For example: 21:14:51.827"))] [/date.documentation diff --git a/stdlib/source/documentation/lux/world/time/date.lux b/stdlib/source/documentation/lux/world/time/date.lux index 17fd0143b..6c508233f 100644 --- a/stdlib/source/documentation/lux/world/time/date.lux +++ b/stdlib/source/documentation/lux/world/time/date.lux @@ -25,14 +25,14 @@ ($.default /.of_days) ($.default /.enum) - ($.documentation /.Date + ($.definition /.Date "A date specified as a year/month/day triplet.") - ($.documentation /.date + ($.definition /.date "A date, within the allowed limits." [(date year month day_of_month)]) - ($.documentation /.codec + ($.definition /.codec (format "Based on ISO 8601." \n "For example: 2017-01-15"))] [])) diff --git a/stdlib/source/documentation/lux/world/time/day.lux b/stdlib/source/documentation/lux/world/time/day.lux index e7923dfe0..c72d8dbb3 100644 --- a/stdlib/source/documentation/lux/world/time/day.lux +++ b/stdlib/source/documentation/lux/world/time/day.lux @@ -22,9 +22,9 @@ ($.default /.by_number) ($.default /.hash) - ($.documentation /.Day + ($.definition /.Day "A day of the week.") - ($.documentation /.week + ($.definition /.week "All the days, ordered by when they come in a week.")] [])) diff --git a/stdlib/source/documentation/lux/world/time/duration.lux b/stdlib/source/documentation/lux/world/time/duration.lux index 0b9ddaa0b..3cc1a1372 100644 --- a/stdlib/source/documentation/lux/world/time/duration.lux +++ b/stdlib/source/documentation/lux/world/time/duration.lux @@ -38,10 +38,10 @@ ($.default /.codec) ($.default /.enum) - ($.documentation /.Duration + ($.definition /.Duration "Durations have a resolution of milli-seconds.") - ($.documentation /.difference + ($.definition /.difference "" [(difference from to)])] [])) diff --git a/stdlib/source/documentation/lux/world/time/instant.lux b/stdlib/source/documentation/lux/world/time/instant.lux index c5fbe2b01..b06126fc8 100644 --- a/stdlib/source/documentation/lux/world/time/instant.lux +++ b/stdlib/source/documentation/lux/world/time/instant.lux @@ -21,36 +21,36 @@ ($.default /.time) ($.default /.day_of_week) - ($.documentation /.Instant + ($.definition /.Instant "Instant is defined as milli-seconds since the epoch.") - ($.documentation /.span + ($.definition /.span "" [(span from to)]) - ($.documentation /.after + ($.definition /.after "" [(after duration instant)]) - ($.documentation /.relative + ($.definition /.relative "" [(relative instant)]) - ($.documentation /.absolute + ($.definition /.absolute "" [(absolute offset)]) - ($.documentation /.epoch + ($.definition /.epoch "The instant corresponding to 1970-01-01T00:00:00Z.") - ($.documentation /.codec + ($.definition /.codec (format "Based on ISO 8601." \n "For example: 2017-01-15T21:14:51.827Z")) - ($.documentation /.now + ($.definition /.now "Yields the current instant, as measured from the operating-system's clock.") - ($.documentation /.of_date_time + ($.definition /.of_date_time "" [(of_date_time date time)])] [])) diff --git a/stdlib/source/documentation/lux/world/time/month.lux b/stdlib/source/documentation/lux/world/time/month.lux index 9e9d4dc28..6ad0cc526 100644 --- a/stdlib/source/documentation/lux/world/time/month.lux +++ b/stdlib/source/documentation/lux/world/time/month.lux @@ -22,17 +22,17 @@ ($.default /.not_a_month_of_the_year) ($.default /.codec) - ($.documentation /.Month + ($.definition /.Month "A month of the year.") - ($.documentation /.days + ($.definition /.days "The amount of days of a month." [(days month)]) - ($.documentation /.leap_year_days + ($.definition /.leap_year_days "The amount of days of a month (in a leap year)." [(leap_year_days month)]) - ($.documentation /.year + ($.definition /.year "All the months, ordered by when they come in a year.")] [])) diff --git a/stdlib/source/documentation/lux/world/time/year.lux b/stdlib/source/documentation/lux/world/time/year.lux index 1ac6a11ca..93a7c34aa 100644 --- a/stdlib/source/documentation/lux/world/time/year.lux +++ b/stdlib/source/documentation/lux/world/time/year.lux @@ -23,26 +23,26 @@ ($.default /.equivalence) ($.default /.order) - ($.documentation /.Year + ($.definition /.Year (format "A year in the gregorian calendar." \n "Both negative (< 0) and positive (> 0) values are valid, but not 0." \n "This is because the first year of the gregorian calendar was year 1.")) - ($.documentation /.year + ($.definition /.year "A valid year in the gregorian calendar, if possible." [(year value)]) - ($.documentation /.days + ($.definition /.days "The amount of days in a typical year.") - ($.documentation /.Period + ($.definition /.Period "An amount of years.") - ($.documentation /.leaps + ($.definition /.leaps "The number of leap years in a period of years." [(leaps year)]) - ($.documentation /.codec + ($.definition /.codec (format "Based on ISO 8601." \n "For example: 2017"))] [])) |