aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-04-21 14:45:39 -0400
committerBruce Hill <bruce@bruce-hill.com>2025-04-21 14:45:39 -0400
commit6ee5af0a16a5f1a32eb933e30d8b86ff4e691beb (patch)
treea4ccc48bef576be1cfd4d30342eebc684474e8f5
parent868ca31562dcc5d484d8f015adfa173c0a43c415 (diff)
Add short descriptions for API methods to improve manpages
-rw-r--r--api/api.md17
-rw-r--r--api/booleans.md2
-rw-r--r--api/booleans.yaml3
-rw-r--r--api/builtins.yaml9
-rw-r--r--api/bytes.yaml4
-rw-r--r--api/integers.yaml15
-rw-r--r--api/lists.yaml26
-rw-r--r--api/nums.yaml65
-rw-r--r--api/paths.yaml39
-rw-r--r--api/sets.yaml11
-rw-r--r--api/tables.yaml6
-rw-r--r--api/text.md15
-rw-r--r--api/text.yaml54
-rw-r--r--man/man3/tomo-Bool.parse.310
-rw-r--r--man/man3/tomo-Byte.hex.38
-rw-r--r--man/man3/tomo-Byte.is_between.38
-rw-r--r--man/man3/tomo-Byte.parse.38
-rw-r--r--man/man3/tomo-Byte.to.38
-rw-r--r--man/man3/tomo-Int.abs.38
-rw-r--r--man/man3/tomo-Int.choose.38
-rw-r--r--man/man3/tomo-Int.clamped.38
-rw-r--r--man/man3/tomo-Int.factorial.38
-rw-r--r--man/man3/tomo-Int.format.38
-rw-r--r--man/man3/tomo-Int.hex.38
-rw-r--r--man/man3/tomo-Int.is_between.38
-rw-r--r--man/man3/tomo-Int.is_prime.38
-rw-r--r--man/man3/tomo-Int.next_prime.38
-rw-r--r--man/man3/tomo-Int.octal.38
-rw-r--r--man/man3/tomo-Int.onward.38
-rw-r--r--man/man3/tomo-Int.parse.38
-rw-r--r--man/man3/tomo-Int.prev_prime.38
-rw-r--r--man/man3/tomo-Int.sqrt.38
-rw-r--r--man/man3/tomo-Int.to.38
-rw-r--r--man/man3/tomo-List.binary_search.38
-rw-r--r--man/man3/tomo-List.by.38
-rw-r--r--man/man3/tomo-List.clear.38
-rw-r--r--man/man3/tomo-List.counts.38
-rw-r--r--man/man3/tomo-List.find.38
-rw-r--r--man/man3/tomo-List.first.38
-rw-r--r--man/man3/tomo-List.from.38
-rw-r--r--man/man3/tomo-List.has.38
-rw-r--r--man/man3/tomo-List.heap_pop.38
-rw-r--r--man/man3/tomo-List.heap_push.38
-rw-r--r--man/man3/tomo-List.heapify.38
-rw-r--r--man/man3/tomo-List.insert.38
-rw-r--r--man/man3/tomo-List.insert_all.38
-rw-r--r--man/man3/tomo-List.pop.38
-rw-r--r--man/man3/tomo-List.random.38
-rw-r--r--man/man3/tomo-List.remove_at.38
-rw-r--r--man/man3/tomo-List.remove_item.38
-rw-r--r--man/man3/tomo-List.reversed.38
-rw-r--r--man/man3/tomo-List.sample.38
-rw-r--r--man/man3/tomo-List.shuffle.38
-rw-r--r--man/man3/tomo-List.shuffled.38
-rw-r--r--man/man3/tomo-List.slice.38
-rw-r--r--man/man3/tomo-List.sort.38
-rw-r--r--man/man3/tomo-List.sorted.38
-rw-r--r--man/man3/tomo-List.to.38
-rw-r--r--man/man3/tomo-List.unique.38
-rw-r--r--man/man3/tomo-Num.1_PI.37
-rw-r--r--man/man3/tomo-Num.2_PI.37
-rw-r--r--man/man3/tomo-Num.2_SQRTPI.37
-rw-r--r--man/man3/tomo-Num.E.37
-rw-r--r--man/man3/tomo-Num.INF.37
-rw-r--r--man/man3/tomo-Num.LN10.37
-rw-r--r--man/man3/tomo-Num.LN2.37
-rw-r--r--man/man3/tomo-Num.LOG2E.37
-rw-r--r--man/man3/tomo-Num.PI.37
-rw-r--r--man/man3/tomo-Num.PI_2.37
-rw-r--r--man/man3/tomo-Num.PI_4.37
-rw-r--r--man/man3/tomo-Num.SQRT1_2.37
-rw-r--r--man/man3/tomo-Num.SQRT2.37
-rw-r--r--man/man3/tomo-Num.TAU.37
-rw-r--r--man/man3/tomo-Num.abs.38
-rw-r--r--man/man3/tomo-Num.acos.38
-rw-r--r--man/man3/tomo-Num.acosh.38
-rw-r--r--man/man3/tomo-Num.asin.38
-rw-r--r--man/man3/tomo-Num.asinh.38
-rw-r--r--man/man3/tomo-Num.atan.38
-rw-r--r--man/man3/tomo-Num.atan2.38
-rw-r--r--man/man3/tomo-Num.atanh.38
-rw-r--r--man/man3/tomo-Num.cbrt.38
-rw-r--r--man/man3/tomo-Num.ceil.38
-rw-r--r--man/man3/tomo-Num.clamped.38
-rw-r--r--man/man3/tomo-Num.copysign.38
-rw-r--r--man/man3/tomo-Num.cos.38
-rw-r--r--man/man3/tomo-Num.cosh.38
-rw-r--r--man/man3/tomo-Num.erf.38
-rw-r--r--man/man3/tomo-Num.erfc.38
-rw-r--r--man/man3/tomo-Num.exp.38
-rw-r--r--man/man3/tomo-Num.exp2.38
-rw-r--r--man/man3/tomo-Num.expm1.38
-rw-r--r--man/man3/tomo-Num.fdim.38
-rw-r--r--man/man3/tomo-Num.floor.38
-rw-r--r--man/man3/tomo-Num.format.38
-rw-r--r--man/man3/tomo-Num.hypot.38
-rw-r--r--man/man3/tomo-Num.is_between.38
-rw-r--r--man/man3/tomo-Num.isfinite.38
-rw-r--r--man/man3/tomo-Num.isinf.38
-rw-r--r--man/man3/tomo-Num.j0.38
-rw-r--r--man/man3/tomo-Num.j1.38
-rw-r--r--man/man3/tomo-Num.log.38
-rw-r--r--man/man3/tomo-Num.log10.38
-rw-r--r--man/man3/tomo-Num.log1p.38
-rw-r--r--man/man3/tomo-Num.log2.38
-rw-r--r--man/man3/tomo-Num.logb.38
-rw-r--r--man/man3/tomo-Num.mix.38
-rw-r--r--man/man3/tomo-Num.near.38
-rw-r--r--man/man3/tomo-Num.nextafter.38
-rw-r--r--man/man3/tomo-Num.parse.38
-rw-r--r--man/man3/tomo-Num.percent.38
-rw-r--r--man/man3/tomo-Num.rint.38
-rw-r--r--man/man3/tomo-Num.round.38
-rw-r--r--man/man3/tomo-Num.scientific.38
-rw-r--r--man/man3/tomo-Num.significand.38
-rw-r--r--man/man3/tomo-Num.sin.38
-rw-r--r--man/man3/tomo-Num.sinh.38
-rw-r--r--man/man3/tomo-Num.sqrt.38
-rw-r--r--man/man3/tomo-Num.tan.38
-rw-r--r--man/man3/tomo-Num.tanh.38
-rw-r--r--man/man3/tomo-Num.tgamma.38
-rw-r--r--man/man3/tomo-Num.trunc.38
-rw-r--r--man/man3/tomo-Num.y0.38
-rw-r--r--man/man3/tomo-Num.y1.38
-rw-r--r--man/man3/tomo-Path.accessed.38
-rw-r--r--man/man3/tomo-Path.append.38
-rw-r--r--man/man3/tomo-Path.append_bytes.38
-rw-r--r--man/man3/tomo-Path.base_name.38
-rw-r--r--man/man3/tomo-Path.by_line.38
-rw-r--r--man/man3/tomo-Path.can_execute.38
-rw-r--r--man/man3/tomo-Path.can_read.38
-rw-r--r--man/man3/tomo-Path.can_write.38
-rw-r--r--man/man3/tomo-Path.changed.38
-rw-r--r--man/man3/tomo-Path.child.38
-rw-r--r--man/man3/tomo-Path.children.38
-rw-r--r--man/man3/tomo-Path.create_directory.38
-rw-r--r--man/man3/tomo-Path.current_dir.37
-rw-r--r--man/man3/tomo-Path.exists.38
-rw-r--r--man/man3/tomo-Path.expand_home.38
-rw-r--r--man/man3/tomo-Path.extension.38
-rw-r--r--man/man3/tomo-Path.files.38
-rw-r--r--man/man3/tomo-Path.from_components.38
-rw-r--r--man/man3/tomo-Path.glob.314
-rw-r--r--man/man3/tomo-Path.group.38
-rw-r--r--man/man3/tomo-Path.is_directory.38
-rw-r--r--man/man3/tomo-Path.is_file.38
-rw-r--r--man/man3/tomo-Path.is_socket.38
-rw-r--r--man/man3/tomo-Path.is_symlink.38
-rw-r--r--man/man3/tomo-Path.modified.38
-rw-r--r--man/man3/tomo-Path.owner.38
-rw-r--r--man/man3/tomo-Path.parent.38
-rw-r--r--man/man3/tomo-Path.read.38
-rw-r--r--man/man3/tomo-Path.read_bytes.38
-rw-r--r--man/man3/tomo-Path.relative_to.38
-rw-r--r--man/man3/tomo-Path.remove.38
-rw-r--r--man/man3/tomo-Path.resolved.38
-rw-r--r--man/man3/tomo-Path.set_owner.38
-rw-r--r--man/man3/tomo-Path.subdirectories.38
-rw-r--r--man/man3/tomo-Path.unique_directory.38
-rw-r--r--man/man3/tomo-Path.write.38
-rw-r--r--man/man3/tomo-Path.write_bytes.38
-rw-r--r--man/man3/tomo-Path.write_unique.38
-rw-r--r--man/man3/tomo-Path.write_unique_bytes.38
-rw-r--r--man/man3/tomo-Set.add.38
-rw-r--r--man/man3/tomo-Set.add_all.38
-rw-r--r--man/man3/tomo-Set.clear.38
-rw-r--r--man/man3/tomo-Set.has.38
-rw-r--r--man/man3/tomo-Set.is_subset_of.38
-rw-r--r--man/man3/tomo-Set.is_superset_of.38
-rw-r--r--man/man3/tomo-Set.overlap.38
-rw-r--r--man/man3/tomo-Set.remove.38
-rw-r--r--man/man3/tomo-Set.remove_all.38
-rw-r--r--man/man3/tomo-Set.with.38
-rw-r--r--man/man3/tomo-Set.without.38
-rw-r--r--man/man3/tomo-Table.clear.38
-rw-r--r--man/man3/tomo-Table.get.38
-rw-r--r--man/man3/tomo-Table.get_or_set.38
-rw-r--r--man/man3/tomo-Table.has.38
-rw-r--r--man/man3/tomo-Table.remove.38
-rw-r--r--man/man3/tomo-Table.set.38
-rw-r--r--man/man3/tomo-Text.as_c_string.38
-rw-r--r--man/man3/tomo-Text.at.38
-rw-r--r--man/man3/tomo-Text.by_line.38
-rw-r--r--man/man3/tomo-Text.by_split.38
-rw-r--r--man/man3/tomo-Text.by_split_any.38
-rw-r--r--man/man3/tomo-Text.bytes.38
-rw-r--r--man/man3/tomo-Text.caseless_equals.38
-rw-r--r--man/man3/tomo-Text.codepoint_names.38
-rw-r--r--man/man3/tomo-Text.ends_with.38
-rw-r--r--man/man3/tomo-Text.from.38
-rw-r--r--man/man3/tomo-Text.from_bytes.38
-rw-r--r--man/man3/tomo-Text.from_c_string.38
-rw-r--r--man/man3/tomo-Text.from_codepoint_names.38
-rw-r--r--man/man3/tomo-Text.from_codepoints.38
-rw-r--r--man/man3/tomo-Text.has.38
-rw-r--r--man/man3/tomo-Text.join.38
-rw-r--r--man/man3/tomo-Text.left_pad.38
-rw-r--r--man/man3/tomo-Text.lines.38
-rw-r--r--man/man3/tomo-Text.lower.38
-rw-r--r--man/man3/tomo-Text.middle_pad.38
-rw-r--r--man/man3/tomo-Text.quoted.38
-rw-r--r--man/man3/tomo-Text.repeat.38
-rw-r--r--man/man3/tomo-Text.replace.38
-rw-r--r--man/man3/tomo-Text.reversed.38
-rw-r--r--man/man3/tomo-Text.right_pad.38
-rw-r--r--man/man3/tomo-Text.slice.38
-rw-r--r--man/man3/tomo-Text.split.38
-rw-r--r--man/man3/tomo-Text.split_any.38
-rw-r--r--man/man3/tomo-Text.starts_with.38
-rw-r--r--man/man3/tomo-Text.title.38
-rw-r--r--man/man3/tomo-Text.to.38
-rw-r--r--man/man3/tomo-Text.translate.323
-rw-r--r--man/man3/tomo-Text.trim.38
-rw-r--r--man/man3/tomo-Text.upper.38
-rw-r--r--man/man3/tomo-Text.utf32_codepoints.38
-rw-r--r--man/man3/tomo-Text.width.38
-rw-r--r--man/man3/tomo-Text.without_prefix.38
-rw-r--r--man/man3/tomo-Text.without_suffix.38
-rw-r--r--man/man3/tomo-USE_COLOR.37
-rw-r--r--man/man3/tomo-ask.38
-rw-r--r--man/man3/tomo-exit.38
-rw-r--r--man/man3/tomo-fail.38
-rw-r--r--man/man3/tomo-getenv.38
-rw-r--r--man/man3/tomo-print.38
-rw-r--r--man/man3/tomo-say.38
-rw-r--r--man/man3/tomo-setenv.38
-rw-r--r--man/man3/tomo-sleep.38
227 files changed, 1092 insertions, 893 deletions
diff --git a/api/api.md b/api/api.md
index f355163b..15526d43 100644
--- a/api/api.md
+++ b/api/api.md
@@ -189,7 +189,7 @@ sleep(1.5)
Bool.parse : func(text: Text -> Bool?)
```
-Converts a string representation of a boolean value into a boolean. Acceptable boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`, `true`/`false`, `on`/`off`.
+Converts a text representation of a boolean value into a boolean. Acceptable boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`, `true`/`false`, `on`/`off`.
Argument | Type | Description | Default
---------|------|-------------|---------
@@ -4664,13 +4664,14 @@ last | `Int` | The index of the last grapheme cluster to include (1-indexed). |
## Text.translate
```tomo
-Text.translate : func(translations: {Text=Text} -> Text)
+Text.translate : func(text: Text, translations: {Text=Text} -> Text)
```
Takes a table mapping target texts to their replacements and performs all the replacements in the table on the whole text. At each position, the first matching replacement is applied and the matching moves on to *after* the replacement text, so replacement text is not recursively modified. See Text.replace() for more information about replacement behavior.
Argument | Type | Description | Default
---------|------|-------------|---------
+text | `Text` | The text to be translated. | -
translations | `{Text=Text}` | A table mapping from target text to its replacement. | -
**Return:** The text with all occurrences of the targets replaced with their corresponding replacement text.
@@ -4679,12 +4680,12 @@ translations | `{Text=Text}` | A table mapping from target text to its replaceme
**Example:**
```tomo
>> "A <tag> & an amperand".translate({
-"&" = "&amp;",
-"<" = "&lt;",
-">" = "&gt;",
-'"" = "&quot",
-"'" = "&#39;",
-}
+ "&" = "&amp;",
+ "<" = "&lt;",
+ ">" = "&gt;",
+ '"" = "&quot",
+ "'" = "&#39;",
+})
= "A &lt;tag&gt; &amp; an ampersand"
```
diff --git a/api/booleans.md b/api/booleans.md
index 338a26e9..d45be505 100644
--- a/api/booleans.md
+++ b/api/booleans.md
@@ -9,7 +9,7 @@
Bool.parse : func(text: Text -> Bool?)
```
-Converts a string representation of a boolean value into a boolean. Acceptable boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`, `true`/`false`, `on`/`off`.
+Converts a text representation of a boolean value into a boolean. Acceptable boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`, `true`/`false`, `on`/`off`.
Argument | Type | Description | Default
---------|------|-------------|---------
diff --git a/api/booleans.yaml b/api/booleans.yaml
index 851b7b0b..0831ac18 100644
--- a/api/booleans.yaml
+++ b/api/booleans.yaml
@@ -1,6 +1,7 @@
Bool.parse:
+ short: parse into boolean
description: >
- Converts a string representation of a boolean value into a boolean. Acceptable
+ Converts a text representation of a boolean value into a boolean. Acceptable
boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`,
`true`/`false`, `on`/`off`.
return:
diff --git a/api/builtins.yaml b/api/builtins.yaml
index 269380ca..6bb6d762 100644
--- a/api/builtins.yaml
+++ b/api/builtins.yaml
@@ -1,4 +1,5 @@
ask:
+ short: get user input
description: >
Gets a line of user input text with a prompt.
note: >
@@ -34,6 +35,7 @@ ask:
= "Arthur Dent"
exit:
+ short: exit the program
description: >
Exits the program with a given status and optionally prints a message.
return:
@@ -56,6 +58,7 @@ exit:
exit(status=1, "Goodbye forever!")
getenv:
+ short: get an environment variable
description: >
Gets an environment variable.
return:
@@ -72,6 +75,7 @@ getenv:
= "xterm-256color"?
print:
+ short: print some text
description: >
Prints a message to the console (alias for say()).
return:
@@ -93,6 +97,7 @@ print:
print("world!")
say:
+ short: print some text
description: >
Prints a message to the console.
return:
@@ -114,6 +119,7 @@ say:
say("world!")
setenv:
+ short: set an environment variable
description: >
Sets an environment variable.
return:
@@ -133,6 +139,7 @@ setenv:
setenv("FOOBAR", "xyz")
sleep:
+ short: wait for an interval
description: >
Pause execution for a given number of seconds.
return:
@@ -148,6 +155,7 @@ sleep:
sleep(1.5)
fail:
+ short: abort the program
description: >
Prints a message to the console, aborts the program, and prints a stack trace.
return:
@@ -163,6 +171,7 @@ fail:
fail("Oh no!")
USE_COLOR:
+ short: whether to use colors
type: Bool
description: >
Whether or not the console prefers ANSI color escape sequences in the output.
diff --git a/api/bytes.yaml b/api/bytes.yaml
index 01f27fc3..52f48528 100644
--- a/api/bytes.yaml
+++ b/api/bytes.yaml
@@ -1,4 +1,5 @@
Byte.hex:
+ short: convert to hexidecimal
description: >
Convert a byte to a hexidecimal text representation.
return:
@@ -25,6 +26,7 @@ Byte.hex:
= "0x12"
Byte.is_between:
+ short: test if inside a range
description: >
Determines if an integer is between two numbers (inclusive).
return:
@@ -53,6 +55,7 @@ Byte.is_between:
= yes
Byte.parse:
+ short: convert text to a byte
description: >
Parse a byte literal from text.
return:
@@ -71,6 +74,7 @@ Byte.parse:
= none
Byte.to:
+ short: iterate over a range of bytes
description: >
Returns an iterator function that iterates over the range of bytes specified.
return:
diff --git a/api/integers.yaml b/api/integers.yaml
index e13246e8..4e5ec46c 100644
--- a/api/integers.yaml
+++ b/api/integers.yaml
@@ -1,4 +1,5 @@
Int.abs:
+ short: absolute value
description: >
Calculates the absolute value of an integer.
return:
@@ -15,6 +16,7 @@ Int.abs:
= 10
Int.choose:
+ short: binomial coefficient
description: >
Computes the binomial coefficient of the given numbers (the equivalent of `n`
choose `k` in combinatorics). This is equal to `n.factorial()/(k.factorial() *
@@ -38,6 +40,7 @@ Int.choose:
= 6
Int.clamped:
+ short: clamp an integer
description: >
Returns the given number clamped between two values so that it is within
that range.
@@ -63,6 +66,7 @@ Int.clamped:
= 5
Int.factorial:
+ short: factorial
description: >
Computes the factorial of an integer.
return:
@@ -79,6 +83,7 @@ Int.factorial:
= 3628800
Int.format:
+ short: text formatting
description: >
Formats an integer as a string with a specified number of digits.
return:
@@ -100,6 +105,7 @@ Int.format:
= "00042"
Int.hex:
+ short: convert to hexidecimal
description: >
Converts an integer to its hexadecimal representation.
return:
@@ -131,6 +137,7 @@ Int.hex:
= "0x00FF"
Int.is_between:
+ short: test if an int is in a range
description: >
Determines if an integer is between two numbers (inclusive).
return:
@@ -159,6 +166,7 @@ Int.is_between:
= yes
Int.is_prime:
+ short: check if an integer is prime
description: >
Determines if an integer is a prime number.
note: >
@@ -187,6 +195,7 @@ Int.is_prime:
= no
Int.next_prime:
+ short: get the next prime
description: >
Finds the next prime number greater than the given integer.
note: >
@@ -208,6 +217,7 @@ Int.next_prime:
= 13
Int.octal:
+ short: convert to octal
description: >
Converts an integer to its octal representation.
return:
@@ -234,6 +244,7 @@ Int.octal:
= "0o0100"
Int.onward:
+ short: iterate from a number onward
description: >
Return an iterator that counts infinitely from the starting integer (with an
optional step size).
@@ -260,6 +271,7 @@ Int.onward:
= [5, 6, 7, 8, 9, 10]
Int.parse:
+ short: convert text to integer
description: >
Converts a text representation of an integer into an integer.
return:
@@ -288,6 +300,7 @@ Int.parse:
= none : Int8?
Int.prev_prime:
+ short: get the previous prime
description: >
Finds the previous prime number less than the given integer.
If there is no previous prime number (i.e. if a number less than `2` is
@@ -311,6 +324,7 @@ Int.prev_prime:
= 7
Int.sqrt:
+ short: square root
description: >
Calculates the nearest square root of an integer.
return:
@@ -329,6 +343,7 @@ Int.sqrt:
= 4
Int.to:
+ short: iterate a range of integers
description: >
Returns an iterator function that iterates over the range of numbers specified.
return:
diff --git a/api/lists.yaml b/api/lists.yaml
index c746cf57..4a7c48c1 100644
--- a/api/lists.yaml
+++ b/api/lists.yaml
@@ -1,4 +1,5 @@
List.binary_search:
+ short: binary search
description: >
Performs a binary search on a sorted list.
return:
@@ -30,6 +31,7 @@ List.binary_search:
= 6
List.by:
+ short: slice by a step value
description: >
Creates a new list with elements spaced by the specified step value.
return:
@@ -50,6 +52,7 @@ List.by:
= [1, 3, 5]
List.clear:
+ short: clear a list
description: >
Clears all elements from the list.
return:
@@ -65,6 +68,7 @@ List.clear:
>> my_list.clear()
List.counts:
+ short: count occurrences
description: >
Counts the occurrences of each element in the list.
return:
@@ -81,6 +85,7 @@ List.counts:
= {10=1, 20=1, 30=3}
List.find:
+ short: find an element's index
description: >
Finds the index of the first occurrence of an element (if any).
return:
@@ -104,6 +109,7 @@ List.find:
= none : Int?
List.first:
+ short: find an index where a predicate matches
description: >
Find the index of the first item that matches a predicate function (if any).
return:
@@ -128,6 +134,7 @@ List.first:
= none : Int?
List.from:
+ short: slice an array from a start index
description: >
Returns a slice of the list starting from a specified index.
return:
@@ -148,6 +155,7 @@ List.from:
= [30, 40, 50]
List.has:
+ short: check for member
description: >
Checks if the list has an element.
return:
@@ -168,6 +176,7 @@ List.has:
= yes
List.heap_pop:
+ short: heap pop
description: >
Removes and returns the top element of a heap or `none` if the list is empty.
By default, this is the *minimum* value in the heap.
@@ -193,6 +202,7 @@ List.heap_pop:
= 10
List.heap_push:
+ short: heap push
description: >
Adds an element to the heap and maintains the heap property. By default, this
is a *minimum* heap.
@@ -218,6 +228,7 @@ List.heap_push:
>> my_heap.heap_push(10)
List.heapify:
+ short: convert a list into a heap
description: >
Converts a list into a heap.
return:
@@ -240,6 +251,7 @@ List.heapify:
>> my_heap.heapify()
List.insert:
+ short: add an item to a list
description: >
Inserts an element at a specified position in the list.
return:
@@ -274,6 +286,7 @@ List.insert:
= [10, 999, 20, 30]
List.insert_all:
+ short: add multiple items to a list
description: >
Inserts a list of items at a specified position in the list.
return:
@@ -308,6 +321,7 @@ List.insert_all:
= [10, 99, 100, 20, 30, 40]
List.pop:
+ short: pop an item from a list
description: >
Removes and returns an item from the list. If the given index is present in
the list, the item at that index will be removed and the list will become one
@@ -344,6 +358,7 @@ List.pop:
= &[10, 30]
List.random:
+ short: pick a random element
description: >
Selects a random element from the list.
return:
@@ -367,6 +382,7 @@ List.random:
= 20
List.remove_at:
+ short: remove an item by index
description: >
Removes elements from the list starting at a specified index.
return:
@@ -402,6 +418,7 @@ List.remove_at:
= [10, 50]
List.remove_item:
+ short: remove an item by value
description: >
Removes all occurrences of a specified item from the list.
return:
@@ -435,6 +452,7 @@ List.remove_item:
= [20, 30]
List.reversed:
+ short: get a reversed list
description: >
Returns a reversed slice of the list.
return:
@@ -451,6 +469,7 @@ List.reversed:
= [30, 20, 10]
List.sample:
+ short: weighted random choices
description: >
Selects a sample of elements from the list, optionally with weighted
probabilities.
@@ -495,6 +514,7 @@ List.sample:
= [10, 10]
List.shuffle:
+ short: shuffle a list in place
description: >
Shuffles the elements of the list in place.
return:
@@ -517,6 +537,7 @@ List.shuffle:
>> list.shuffle()
List.shuffled:
+ short: return a shuffled list
description: >
Creates a new list with elements shuffled.
return:
@@ -540,6 +561,7 @@ List.shuffled:
= [40, 10, 30, 20]
List.slice:
+ short: get a slice of a list
description: >
Returns a slice of the list spanning the given indices (inclusive).
return:
@@ -569,6 +591,7 @@ List.slice:
= [30, 40]
List.sort:
+ short: sort a list
description: >
Sorts the elements of the list in place in ascending order (small to large).
return:
@@ -596,6 +619,7 @@ List.sort:
= [10, 20, -30, 40]
List.sorted:
+ short: sorted copy of a list
description: >
Creates a new list with elements sorted.
return:
@@ -620,6 +644,7 @@ List.sorted:
= [10, 20, -30, 40]
List.to:
+ short: slice a list to an end index
description: >
Returns a slice of the list from the start of the original list up to a specified index (inclusive).
return:
@@ -643,6 +668,7 @@ List.to:
= [10, 20, 30, 40]
List.unique:
+ short: convert a list to a set
description: >
Returns a Set that contains the unique elements of the list.
return:
diff --git a/api/nums.yaml b/api/nums.yaml
index d69a6b9e..37b2c7c5 100644
--- a/api/nums.yaml
+++ b/api/nums.yaml
@@ -1,4 +1,5 @@
Num.abs:
+ short: absolute value
description: >
Calculates the absolute value of a number.
return:
@@ -15,6 +16,7 @@ Num.abs:
= 3.5
Num.acos:
+ short: arc cosine
description: >
Computes the arc cosine of a number.
return:
@@ -31,6 +33,7 @@ Num.acos:
= 1.5708
Num.acosh:
+ short: arc hyperbolic cosine
description: >
Computes the inverse hyperbolic cosine of a number.
return:
@@ -47,6 +50,7 @@ Num.acosh:
= 0
Num.asin:
+ short: arc sine
description: >
Computes the arc sine of a number.
return:
@@ -63,6 +67,7 @@ Num.asin:
= 0.5236
Num.asinh:
+ short: arc hyperbolic sine
description: >
Computes the inverse hyperbolic sine of a number.
return:
@@ -79,6 +84,7 @@ Num.asinh:
= 0
Num.atan:
+ short: arc tangent
description: >
Computes the arc tangent of a number.
return:
@@ -95,6 +101,7 @@ Num.atan:
= 0.7854
Num.atan2:
+ short: arc tangent from 2 variables
description: >
Computes the arc tangent of the quotient of two numbers.
return:
@@ -115,6 +122,7 @@ Num.atan2:
= 0.7854
Num.atanh:
+ short: arc hyperbolic tangent.
description: >
Computes the inverse hyperbolic tangent of a number.
return:
@@ -131,6 +139,7 @@ Num.atanh:
= 0.5493
Num.cbrt:
+ short: cube root
description: >
Computes the cube root of a number.
return:
@@ -147,6 +156,7 @@ Num.cbrt:
= 3
Num.ceil:
+ short: ceiling function
description: >
Rounds a number up to the nearest integer.
return:
@@ -163,6 +173,7 @@ Num.ceil:
= 4
Num.clamped:
+ short: clamp a number
description: >
Returns the given number clamped between two values so that it is within
that range.
@@ -188,6 +199,7 @@ Num.clamped:
= 5.5
Num.copysign:
+ short: copy a number's sign
description: >
Copies the sign of one number to another.
return:
@@ -208,6 +220,7 @@ Num.copysign:
= -3
Num.cos:
+ short: cosine
description: >
Computes the cosine of a number (angle in radians).
return:
@@ -224,6 +237,7 @@ Num.cos:
= 1
Num.cosh:
+ short: hyperbolic cosine
description: >
Computes the hyperbolic cosine of a number.
return:
@@ -240,6 +254,7 @@ Num.cosh:
= 1
Num.erf:
+ short: error function
description: >
Computes the error function of a number.
return:
@@ -256,6 +271,7 @@ Num.erf:
= 0
Num.erfc:
+ short: complimentary error function
description: >
Computes the complementary error function of a number.
return:
@@ -272,6 +288,7 @@ Num.erfc:
= 1
Num.exp:
+ short: base-e exponentiation
description: >
Computes the exponential function $e^x$ for a number.
return:
@@ -288,6 +305,7 @@ Num.exp:
= 2.7183
Num.exp2:
+ short: base-2 exponentiation
description: >
Computes $2^x$ for a number.
return:
@@ -304,6 +322,7 @@ Num.exp2:
= 8
Num.expm1:
+ short: base-e exponential minus 1
description: >
Computes $e^x - 1$ for a number.
return:
@@ -320,6 +339,7 @@ Num.expm1:
= 1.7183
Num.fdim:
+ short: positive difference
description: >
Computes the positive difference between two numbers.
return:
@@ -342,6 +362,7 @@ Num.fdim:
= 2
Num.floor:
+ short: floor function
description: >
Rounds a number down to the nearest integer.
return:
@@ -358,6 +379,7 @@ Num.floor:
= 3
Num.format:
+ short: convert a number to text
description: >
Formats a number as a text with a specified precision.
return:
@@ -379,6 +401,7 @@ Num.format:
= "3.14"
Num.hypot:
+ short: Euclidean distance function
description: >
Computes the Euclidean norm, $\sqrt{x^2 + y^2}$, of two numbers.
return:
@@ -399,6 +422,7 @@ Num.hypot:
= 5
Num.isfinite:
+ short: check for finite number
description: >
Checks if a number is finite.
return:
@@ -417,6 +441,7 @@ Num.isfinite:
= no
Num.is_between:
+ short: check if a number is in a range
description: >
Determines if a number is between two numbers (inclusive).
return:
@@ -445,6 +470,7 @@ Num.is_between:
= yes
Num.isinf:
+ short: check for infinite number
description: >
Checks if a number is infinite.
return:
@@ -463,6 +489,7 @@ Num.isinf:
= no
Num.j0:
+ short: Bessel function
description: >
Computes the Bessel function of the first kind of order 0.
return:
@@ -479,6 +506,7 @@ Num.j0:
= 1
Num.j1:
+ short: Bessel function
description: >
Computes the Bessel function of the first kind of order 1.
return:
@@ -495,6 +523,7 @@ Num.j1:
= 0
Num.log:
+ short: natural logarithm
description: >
Computes the natural logarithm (base $e$) of a number.
return:
@@ -511,6 +540,7 @@ Num.log:
= 1
Num.log10:
+ short: logarithm base-10
description: >
Computes the base-10 logarithm of a number.
return:
@@ -527,6 +557,7 @@ Num.log10:
= 2
Num.log1p:
+ short: logarithm of 1 plus x
description: >
Computes $\log(1 + x)$ for a number.
return:
@@ -543,6 +574,7 @@ Num.log1p:
= 0.6931
Num.log2:
+ short: logarithm base-2
description: >
Computes the base-2 logarithm of a number.
return:
@@ -559,6 +591,7 @@ Num.log2:
= 3
Num.logb:
+ short: exponent of a floating point value
description: >
Computes the binary exponent (base-2 logarithm) of a number.
return:
@@ -575,6 +608,7 @@ Num.logb:
= 3
Num.mix:
+ short: mix two numbers by an amount
description: >
Interpolates between two numbers based on a given amount.
return:
@@ -601,6 +635,7 @@ Num.mix:
= 12.5
Num.near:
+ short: check if two numbers are near each other
description: >
Checks if two numbers are approximately equal within specified tolerances. If
two numbers are within an absolute difference or the ratio between the two is
@@ -639,6 +674,7 @@ Num.near:
= yes
Num.nextafter:
+ short: next floating point number
description: >
Computes the next representable value after a given number towards a specified direction.
return:
@@ -659,6 +695,7 @@ Num.nextafter:
= 1.0000000000000002
Num.parse:
+ short: convert text to number
description: >
Converts a text representation of a number into a floating-point number.
return:
@@ -678,6 +715,7 @@ Num.parse:
= 1000
Num.percent:
+ short: format as a percentage
description: >
Convert a number into a percentage text with a percent sign.
return:
@@ -701,6 +739,7 @@ Num.percent:
= "33.33%"
Num.rint:
+ short: round to nearest integer
description: >
Rounds a number to the nearest integer, with ties rounded to the nearest even integer.
return:
@@ -719,6 +758,7 @@ Num.rint:
= 2
Num.round:
+ short: round to nearest integer
description: >
Rounds a number to the nearest whole number integer.
return:
@@ -737,6 +777,7 @@ Num.round:
= 3
Num.scientific:
+ short: format in scientific notation
description: >
Formats a number in scientific notation with a specified precision.
return:
@@ -758,6 +799,7 @@ Num.scientific:
= "1.23e+04"
Num.significand:
+ short: get mantissa
description: >
Extracts the significand (or mantissa) of a number.
return:
@@ -774,6 +816,7 @@ Num.significand:
= 0.1234567
Num.sin:
+ short: sine
description: >
Computes the sine of a number (angle in radians).
return:
@@ -790,6 +833,7 @@ Num.sin:
= 0
Num.sinh:
+ short: hyperbolic sine
description: >
Computes the hyperbolic sine of a number.
return:
@@ -806,6 +850,7 @@ Num.sinh:
= 0
Num.sqrt:
+ short: square root
description: >
Computes the square root of a number.
return:
@@ -822,6 +867,7 @@ Num.sqrt:
= 4
Num.tan:
+ short: tangent
description: >
Computes the tangent of a number (angle in radians).
return:
@@ -838,6 +884,7 @@ Num.tan:
= 0
Num.tanh:
+ short: hyperbolic tangent
description: >
Computes the hyperbolic tangent of a number.
return:
@@ -854,6 +901,7 @@ Num.tanh:
= 0
Num.tgamma:
+ short: "true gamma function"
description: >
Computes the gamma function of a number.
return:
@@ -870,6 +918,7 @@ Num.tgamma:
= 1
Num.trunc:
+ short: truncate a number
description: >
Truncates a number to the nearest integer towards zero.
return:
@@ -888,6 +937,7 @@ Num.trunc:
= -3
Num.y0:
+ short: Bessel function
description: >
Computes the Bessel function of the second kind of order 0.
return:
@@ -904,6 +954,7 @@ Num.y0:
= -0.7652
Num.y1:
+ short: Bessel function
description: >
Computes the Bessel function of the second kind of order 1.
return:
@@ -921,58 +972,72 @@ Num.y1:
Num.1_PI:
+ short: 1/pi
type: Num
description: >
The constant $\frac{1}{\pi}$.
Num.2_PI:
+ short: 2*pi
type: Num
description: >
The constant $2 \times \pi$.
Num.2_SQRTPI:
+ short: 2*sqrt(pi)
type: Num
description: >
The constant $2 \times \sqrt{\pi}$.
Num.E:
+ short: Euler's constant
type: Num
description: >
The base of the natural logarithm ($e$).
Num.INF:
+ short: infinity
type: Num
description: >
Positive infinity.
Num.LN10:
+ short: log(10)
type: Num
description: >
The natural logarithm of 10.
Num.LN2:
+ short: log(2)
type: Num
description: >
The natural logarithm of 2.
Num.LOG2E:
+ short: log_2(e)
type: Num
description: >
The base 2 logarithm of $e$
Num.PI:
+ short: pi
type: Num
description: >
Pi ($\pi$).
Num.PI_2:
+ short: pi/2
type: Num
description: >
$\frac{\pi}{2}$
Num.PI_4:
+ short: pi/4
type: Num
description: >
$\frac{\pi}{4}$
Num.SQRT1_2:
+ short: sqrt(1/2)
type: Num
description: >
$\sqrt{\frac{1}{2}}$
Num.SQRT2:
+ short: sqrt(2)
type: Num
description: >
$\sqrt{2}$
Num.TAU:
+ short: 2*pi
type: Num
description: >
Tau ($2 \times \pi$)
diff --git a/api/paths.yaml b/api/paths.yaml
index c8df3d7b..f33b7a77 100644
--- a/api/paths.yaml
+++ b/api/paths.yaml
@@ -1,4 +1,5 @@
Path.accessed:
+ short: access time
description: >
Gets the file access time of a file.
return:
@@ -23,6 +24,7 @@ Path.accessed:
= none
Path.append:
+ short: append to a file
description: >
Appends the given text to the file at the specified path, creating the file if
it doesn't already exist. Failure to write will result in a runtime error.
@@ -48,6 +50,7 @@ Path.append:
(./log.txt).append("extra line$(\n)")
Path.append_bytes:
+ short: append bytes to a file
description: >
Appends the given bytes to the file at the specified path, creating the file if
it doesn't already exist. Failure to write will result in a runtime error.
@@ -73,6 +76,7 @@ Path.append_bytes:
(./log.txt).append_bytes([104, 105])
Path.base_name:
+ short: base name of a file
description: >
Returns the base name of the file or directory at the specified path.
return:
@@ -89,6 +93,7 @@ Path.base_name:
= "file.txt"
Path.by_line:
+ short: iterate by line
description: >
Returns an iterator that can be used to iterate over a file one line at a time,
or returns a null value if the file could not be opened.
@@ -115,6 +120,7 @@ Path.by_line:
say(line.upper())
Path.can_execute:
+ short: check execute permissions
description: >
Returns whether or not a file can be executed by the current user/group.
return:
@@ -135,6 +141,7 @@ Path.can_execute:
= no
Path.can_read:
+ short: check read permissions
description: >
Returns whether or not a file can be read by the current user/group.
return:
@@ -155,6 +162,7 @@ Path.can_read:
= no
Path.can_write:
+ short: check write permissions
description: >
Returns whether or not a file can be written by the current user/group.
return:
@@ -175,6 +183,7 @@ Path.can_write:
= no
Path.changed:
+ short: get the last changed time
description: >
Gets the file change time of a file.
note: >
@@ -202,6 +211,7 @@ Path.changed:
= none
Path.child:
+ short: append a child to a path
description: >
Return a path that is a child of another path.
return:
@@ -222,6 +232,7 @@ Path.child:
= (./directory/file.txt)
Path.children:
+ short: get children of a directory
description: >
Returns a list of children (files and directories) within the directory at the specified path. Optionally includes hidden files.
return:
@@ -242,6 +253,7 @@ Path.children:
= [".git", "foo.txt"]
Path.create_directory:
+ short: make a directory
description: >
Creates a new directory at the specified path with the given permissions. If
any of the parent directories do not exist, they will be created as needed.
@@ -262,6 +274,7 @@ Path.create_directory:
(./new_directory).create_directory()
Path.current_dir:
+ short: get current directory
description: >
Creates a new directory at the specified path with the given permissions. If
any of the parent directories do not exist, they will be created as needed.
@@ -275,6 +288,7 @@ Path.current_dir:
= (/home/user/tomo)
Path.exists:
+ short: check if a path exists
description: >
Checks if a file or directory exists at the specified path.
return:
@@ -291,6 +305,7 @@ Path.exists:
= yes
Path.expand_home:
+ short: 'expand ~ to $HOME'
description: >
For home-based paths (those starting with `~`), expand the path to replace the
tilde with and absolute path to the user's `$HOME` directory.
@@ -311,6 +326,7 @@ Path.expand_home:
= /foo
Path.extension:
+ short: get file extension
description: >
Returns the file extension of the file at the specified path. Optionally returns the full extension.
return:
@@ -340,6 +356,7 @@ Path.extension:
= ""
Path.files:
+ short: list files in a directory
description: >
Returns a list of files within the directory at the specified path. Optionally includes hidden files.
return:
@@ -361,6 +378,7 @@ Path.files:
= [(./directory/file1.txt), (./directory/file2.txt)]
Path.from_components:
+ short: build a path from components
description: >
Returns a path built from a list of path components.
return:
@@ -381,6 +399,7 @@ Path.from_components:
= ~/.local
Path.glob:
+ short: perform file globbing
description: >
Perform a globbing operation and return a list of matching paths. Some glob
specific details:
@@ -422,6 +441,7 @@ Path.glob:
= []
Path.group:
+ short: get the owning group
description: >
Get the owning group of a file or directory.
return:
@@ -445,6 +465,7 @@ Path.group:
= none
Path.is_directory:
+ short: check if a path is a directory
description: >
Checks if the path represents a directory. Optionally follows symbolic links.
return:
@@ -468,6 +489,7 @@ Path.is_directory:
= no
Path.is_file:
+ short: check if a path is a file
description: >
Checks if the path represents a file. Optionally follows symbolic links.
return:
@@ -491,6 +513,7 @@ Path.is_file:
= no
Path.is_socket:
+ short: check if a path is a socket
description: >
Checks if the path represents a socket. Optionally follows symbolic links.
return:
@@ -511,6 +534,7 @@ Path.is_socket:
= yes
Path.is_symlink:
+ short: check if a path is a symbolic link
description: >
Checks if the path represents a symbolic link.
return:
@@ -527,6 +551,7 @@ Path.is_symlink:
= yes
Path.modified:
+ short: get file modification time
description: >
Gets the file modification time of a file.
return:
@@ -551,6 +576,7 @@ Path.modified:
= none
Path.owner:
+ short: get file owner
description: >
Get the owning user of a file or directory.
return:
@@ -574,6 +600,7 @@ Path.owner:
= none
Path.parent:
+ short: get parent directory
description: >
Returns the parent directory of the file or directory at the specified path.
return:
@@ -590,6 +617,7 @@ Path.parent:
= (./path/to/)
Path.read:
+ short: read file contents
description: >
Reads the contents of the file at the specified path or a null value if the
file could not be read.
@@ -612,6 +640,7 @@ Path.read:
= none
Path.read_bytes:
+ short: read file contents as bytes
description: >
Reads the contents of the file at the specified path or a null value if the
file could not be read.
@@ -638,6 +667,7 @@ Path.read_bytes:
= none
Path.relative_to:
+ short: apply a relative path to another
description: >
Returns the path relative to a given base path. By default, the base path is the current directory.
return:
@@ -658,6 +688,7 @@ Path.relative_to:
= (./to/file.txt)
Path.remove:
+ short: remove a file or directory
description: >
Removes the file or directory at the specified path. A runtime error is raised if something goes wrong.
return:
@@ -677,6 +708,7 @@ Path.remove:
(./file.txt).remove()
Path.resolved:
+ short: resolve a path
description: >
Resolves the absolute path of the given path relative to a base path. By default, the base path is the current directory.
return:
@@ -700,6 +732,7 @@ Path.resolved:
= (/foo/path/to/file.txt)
Path.set_owner:
+ short: set the owner
description: >
Set the owning user and/or group for a path.
return:
@@ -730,6 +763,7 @@ Path.set_owner:
(./file.txt).set_owner(owner="root", group="wheel")
Path.subdirectories:
+ short: get subdirectories
description: >
Returns a list of subdirectories within the directory at the specified path. Optionally includes hidden subdirectories.
return:
@@ -753,6 +787,7 @@ Path.subdirectories:
= [(./directory/.git), (./directory/subdir1), (./directory/subdir2)]
Path.unique_directory:
+ short: create a directory with a unique name
description: >
Generates a unique directory path based on the given path. Useful for creating temporary directories.
return:
@@ -772,6 +807,7 @@ Path.unique_directory:
created.remove()
Path.write:
+ short: write to a file
description: >
Writes the given text to the file at the specified path, creating the file if
it doesn't already exist. Sets the file permissions as specified. If the file
@@ -797,6 +833,7 @@ Path.write:
(./file.txt).write("Hello, world!")
Path.write_bytes:
+ short: write bytes to a file
description: >
Writes the given bytes to the file at the specified path, creating the file if
it doesn't already exist. Sets the file permissions as specified. If the file
@@ -822,6 +859,7 @@ Path.write_bytes:
(./file.txt).write_bytes([104, 105])
Path.write_unique:
+ short: write to a uniquely named file
description: >
Writes the given text to a unique file path based on the specified path. The
file is created if it doesn't exist. This is useful for creating temporary
@@ -848,6 +886,7 @@ Path.write_unique:
created.remove()
Path.write_unique_bytes:
+ short: write bytes to a uniquely named file
description: >
Writes the given bytes to a unique file path based on the specified path. The
file is created if it doesn't exist. This is useful for creating temporary
diff --git a/api/sets.yaml b/api/sets.yaml
index 19d30f1d..6bf0d8cc 100644
--- a/api/sets.yaml
+++ b/api/sets.yaml
@@ -1,4 +1,5 @@
Set.add:
+ short: add item to a set
description: >
Adds an item to the set.
return:
@@ -18,6 +19,7 @@ Set.add:
>> nums.add(42)
Set.add_all:
+ short: add items to a set
description: >
Adds multiple items to the set.
return:
@@ -37,6 +39,7 @@ Set.add_all:
>> nums.add_all([1, 2, 3])
Set.clear:
+ short: clear a set
description: >
Removes all items from the set.
return:
@@ -52,6 +55,7 @@ Set.clear:
>> nums.clear()
Set.has:
+ short: check if a set has an item
description: >
Checks if the set contains a specified item.
return:
@@ -72,6 +76,7 @@ Set.has:
= yes
Set.is_subset_of:
+ short: check if a set is a subset
description: >
Checks if the set is a subset of another set.
return:
@@ -97,6 +102,7 @@ Set.is_subset_of:
= yes
Set.is_superset_of:
+ short: check if a set is a superset
description: >
Checks if the set is a superset of another set.
return:
@@ -122,6 +128,7 @@ Set.is_superset_of:
= yes
Set.overlap:
+ short: set intersection
description: >
Creates a new set with items that are in both the original set and another set.
return:
@@ -142,6 +149,7 @@ Set.overlap:
= |2|
Set.remove:
+ short: remove an item from a set
description: >
Removes an item from the set.
return:
@@ -161,6 +169,7 @@ Set.remove:
>> nums.remove(42)
Set.remove_all:
+ short: remove items from a set
description: >
Removes multiple items from the set.
return:
@@ -180,6 +189,7 @@ Set.remove_all:
>> nums.remove_all([1, 2, 3])
Set.with:
+ short: set union
description: >
Creates a new set that is the union of the original set and another set.
return:
@@ -200,6 +210,7 @@ Set.with:
= |1, 2, 3|
Set.without:
+ short: set difference
description: >
Creates a new set with items from the original set but without items from another set.
return:
diff --git a/api/tables.yaml b/api/tables.yaml
index 6ab5f505..6a58e818 100644
--- a/api/tables.yaml
+++ b/api/tables.yaml
@@ -1,4 +1,5 @@
Table.clear:
+ short: clear a table
description: >
Removes all key-value pairs from the table.
return:
@@ -14,6 +15,7 @@ Table.clear:
>> t.clear()
Table.get:
+ short: get an item from a table
description: >
Retrieves the value associated with a key, or returns `none` if the key is not present.
note: >
@@ -46,6 +48,7 @@ Table.get:
= 0
Table.get_or_set:
+ short: get an item or set a default if absent
description: >
If the given key is in the table, return the associated value. Otherwise,
insert the given default value into the table and return it.
@@ -85,6 +88,7 @@ Table.get_or_set:
= &{"A"=@[1, 2, 3, 4], "B"=@[99], "C"=@[0, 0, 0]}
Table.has:
+ short: check for a key
description: >
Checks if the table contains a specified key.
return:
@@ -107,6 +111,7 @@ Table.has:
= no
Table.remove:
+ short: remove a table entry
description: >
Removes the key-value pair associated with a specified key.
return:
@@ -129,6 +134,7 @@ Table.remove:
= {"B"=2}
Table.set:
+ short: set a table entry
description: >
Sets or updates the value associated with a specified key.
return:
diff --git a/api/text.md b/api/text.md
index 8f449358..e500e7bf 100644
--- a/api/text.md
+++ b/api/text.md
@@ -771,13 +771,14 @@ last | `Int` | The index of the last grapheme cluster to include (1-indexed). |
## Text.translate
```tomo
-Text.translate : func(translations: {Text=Text} -> Text)
+Text.translate : func(text: Text, translations: {Text=Text} -> Text)
```
Takes a table mapping target texts to their replacements and performs all the replacements in the table on the whole text. At each position, the first matching replacement is applied and the matching moves on to *after* the replacement text, so replacement text is not recursively modified. See Text.replace() for more information about replacement behavior.
Argument | Type | Description | Default
---------|------|-------------|---------
+text | `Text` | The text to be translated. | -
translations | `{Text=Text}` | A table mapping from target text to its replacement. | -
**Return:** The text with all occurrences of the targets replaced with their corresponding replacement text.
@@ -786,12 +787,12 @@ translations | `{Text=Text}` | A table mapping from target text to its replaceme
**Example:**
```tomo
>> "A <tag> & an amperand".translate({
-"&" = "&amp;",
-"<" = "&lt;",
-">" = "&gt;",
-'"" = "&quot",
-"'" = "&#39;",
-}
+ "&" = "&amp;",
+ "<" = "&lt;",
+ ">" = "&gt;",
+ '"" = "&quot",
+ "'" = "&#39;",
+})
= "A &lt;tag&gt; &amp; an ampersand"
```
diff --git a/api/text.yaml b/api/text.yaml
index f70178b2..eb9dc286 100644
--- a/api/text.yaml
+++ b/api/text.yaml
@@ -1,4 +1,5 @@
Text.as_c_string:
+ short: convert to C-style string
description: >
Converts a `Text` value to a C-style string.
return:
@@ -15,6 +16,7 @@ Text.as_c_string:
= CString("Hello")
Text.at:
+ short: get a letter
description: >
Get the graphical cluster at a given index. This is similar to `str[i]` with
ASCII text, but has more correct behavior for unicode text.
@@ -39,6 +41,7 @@ Text.at:
= "é"
Text.by_line:
+ short: iterate by line
description: >
Returns an iterator function that can be used to iterate over the lines in a
text.
@@ -65,6 +68,7 @@ Text.by_line:
say(line)
Text.by_split:
+ short: iterate by a spliting text
description: >
Returns an iterator function that can be used to iterate over text separated by
a delimiter.
@@ -95,6 +99,7 @@ Text.by_split:
say(chunk)
Text.by_split_any:
+ short: iterate by one of many splitting characters
description: >
Returns an iterator function that can be used to iterate over text separated by
one or more characters (grapheme clusters) from a given text of delimiters.
@@ -125,6 +130,7 @@ Text.by_split_any:
say(chunk)
Text.bytes:
+ short: get UTF8 bytes
description: >
Converts a `Text` value to a list of bytes representing a UTF8 encoding of
the text.
@@ -142,6 +148,7 @@ Text.bytes:
= [65, 109, 195, 169, 108, 105, 101]
Text.caseless_equals:
+ short: case-insensitive comparison
description: >
Checks whether two texts are equal, ignoring the casing of the letters (i.e.
case-insensitive comparison).
@@ -172,6 +179,7 @@ Text.caseless_equals:
= no
Text.codepoint_names:
+ short: get unicode codepoint names
description: >
Returns a list of the names of each codepoint in the text.
return:
@@ -188,6 +196,7 @@ Text.codepoint_names:
= ["LATIN CAPITAL LETTER A", "LATIN SMALL LETTER M", "LATIN SMALL LETTER E WITH ACUTE", "LATIN SMALL LETTER L", "LATIN SMALL LETTER I", "LATIN SMALL LETTER E"]
Text.ends_with:
+ short: check suffix
description: >
Checks if the `Text` ends with a literal suffix text.
return:
@@ -208,6 +217,7 @@ Text.ends_with:
= yes
Text.from:
+ short: slice from a starting index
description: >
Get a slice of the text, starting at the given position.
return:
@@ -235,6 +245,7 @@ Text.from:
= "lo"
Text.from_bytes:
+ short: convert UTF8 byte list to text
description: >
Returns text that has been constructed from the given UTF8 bytes.
note: >
@@ -254,6 +265,7 @@ Text.from_bytes:
= "Ã…ke"
Text.from_c_string:
+ short: convert C-style string to text
description: >
Converts a C-style string to a `Text` value.
return:
@@ -270,6 +282,7 @@ Text.from_c_string:
= "Hello"
Text.from_codepoint_names:
+ short: convert list of unicode codepoint names to text
description: >
Returns text that has the given codepoint names (according to the Unicode
specification) as its codepoints.
@@ -295,6 +308,7 @@ Text.from_codepoint_names:
= "Ã…ke"
Text.from_codepoints:
+ short: convert UTF32 codepoints to text
description: >
Returns text that has been constructed from the given UTF32 codepoints.
note: >
@@ -314,6 +328,7 @@ Text.from_codepoints:
= "Ã…ke"
Text.has:
+ short: check for substring
description: >
Checks if the `Text` contains some target text.
return:
@@ -336,6 +351,7 @@ Text.has:
= no
Text.join:
+ short: concatenate with separator
description: >
Joins a list of text pieces with a specified glue.
return:
@@ -356,6 +372,7 @@ Text.join:
= "one, two, three"
Text.middle_pad:
+ short: pad text, centered
description: >
Pad some text on the left and right side so it reaches a target width.
return:
@@ -390,6 +407,7 @@ Text.middle_pad:
= "ABCAxABCAB"
Text.left_pad:
+ short: left-pad text
description: >
Pad some text on the left side so it reaches a target width.
return:
@@ -424,6 +442,7 @@ Text.left_pad:
= "ABCAx"
Text.lines:
+ short: get list of lines
description: >
Splits the text into a list of lines of text, preserving blank lines,
ignoring trailing newlines, and handling `\r\n` the same as `\n`.
@@ -449,6 +468,7 @@ Text.lines:
= []
Text.lower:
+ short: convert to lowercase
description: >
Converts all characters in the text to lowercase.
return:
@@ -473,6 +493,7 @@ Text.lower:
>> "ı"
Text.quoted:
+ short: add quotation marks and escapes
description: >
Formats the text with quotation marks and escapes.
return:
@@ -499,6 +520,7 @@ Text.quoted:
= "\"one\\ntwo\""
Text.repeat:
+ short: repeat text
description: >
Repeat some text multiple times.
return:
@@ -519,6 +541,7 @@ Text.repeat:
= "AbcAbcAbc"
Text.replace:
+ short: replace a substring
description: >
Replaces occurrences of a target text with a replacement text.
return:
@@ -543,6 +566,7 @@ Text.replace:
= "Hello there"
Text.reversed:
+ short: get a reversed copy
description: >
Return a text that has the grapheme clusters in reverse order.
return:
@@ -559,6 +583,7 @@ Text.reversed:
= "cbA"
Text.right_pad:
+ short: right-pad text
description: >
Pad some text on the right side so it reaches a target width.
return:
@@ -593,6 +618,7 @@ Text.right_pad:
= "xABCA"
Text.slice:
+ short: get a slice of a text
description: >
Get a slice of the text.
return:
@@ -629,6 +655,7 @@ Text.slice:
= "ello"
Text.split:
+ short: split a text by a delimiter
description: >
Splits the text into a list of substrings based on exact matches of a delimiter.
return:
@@ -659,6 +686,7 @@ Text.split:
= ["a", "b", "c"]
Text.split_any:
+ short: split a text by multiple delimiters
description: >
Splits the text into a list of substrings at one or more occurrences of a set
of delimiter characters (grapheme clusters).
@@ -686,6 +714,7 @@ Text.split_any:
= ["one", "two", "three"]
Text.starts_with:
+ short: check prefix
description: >
Checks if the `Text` starts with a literal prefix text.
return:
@@ -706,6 +735,7 @@ Text.starts_with:
= yes
Text.title:
+ short: titlecase
description: >
Converts the text to title case (capitalizing the first letter of each word).
return:
@@ -731,6 +761,7 @@ Text.title:
= "İ"
Text.to:
+ short: slice to an end index
description: >
Get a slice of the text, ending at the given position.
return:
@@ -758,6 +789,7 @@ Text.to:
= "goodby"
Text.translate:
+ short: perform multiple replacements
description: >
Takes a table mapping target texts to their replacements and performs all the
replacements in the table on the whole text. At each position, the first
@@ -770,21 +802,26 @@ Text.translate:
The text with all occurrences of the targets replaced with their corresponding
replacement text.
args:
+ text:
+ type: 'Text'
+ description: >
+ The text to be translated.
translations:
type: '{Text=Text}'
description: >
A table mapping from target text to its replacement.
example: |
>> "A <tag> & an amperand".translate({
- "&" = "&amp;",
- "<" = "&lt;",
- ">" = "&gt;",
- '"" = "&quot",
- "'" = "&#39;",
- }
+ "&" = "&amp;",
+ "<" = "&lt;",
+ ">" = "&gt;",
+ '"" = "&quot",
+ "'" = "&#39;",
+ })
= "A &lt;tag&gt; &amp; an ampersand"
Text.trim:
+ short: trim characters
description: >
Trims the given characters (grapheme clusters) from the left and/or right side of the text.
return:
@@ -822,6 +859,7 @@ Text.trim:
= "xyz "
Text.upper:
+ short: uppercase
description: >
Converts all characters in the text to uppercase.
return:
@@ -847,6 +885,7 @@ Text.upper:
= "İ"
Text.utf32_codepoints:
+ short: get UTF32 codepoints
description: >
Returns a list of Unicode code points for UTF32 encoding of the text.
return:
@@ -863,6 +902,7 @@ Text.utf32_codepoints:
= [65, 109, 233, 108, 105, 101]
Text.width:
+ short: get display width
description: >
Returns the display width of the text as seen in a terminal with appropriate
font rendering. This is usually the same as the text's `.length`, but there are
@@ -886,6 +926,7 @@ Text.width:
= 2
Text.without_prefix:
+ short: remove prefix
description: >
Returns the text with a given prefix removed (if present).
return:
@@ -909,6 +950,7 @@ Text.without_prefix:
= "qux"
Text.without_suffix:
+ short: remove suffix
description: >
Returns the text with a given suffix removed (if present).
return:
diff --git a/man/man3/tomo-Bool.parse.3 b/man/man3/tomo-Bool.parse.3
index 5e50e46d..5b4a90e8 100644
--- a/man/man3/tomo-Bool.parse.3
+++ b/man/man3/tomo-Bool.parse.3
@@ -2,20 +2,20 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Bool.parse 3 2025-04-19T14:52:07.132026 "Tomo man-pages"
+.TH Bool.parse 3 2025-04-21T14:44:34.257299 "Tomo man-pages"
.SH NAME
-Bool.parse \- Converts a string representation of a boolean value into a boolean. Acceptable boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`, `true`/`false`, `on`/`off`.
-
+Bool.parse \- parse into boolean
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Bool.parse\ :\ func(text:\ Text\ ->\ Bool?)
.fi
-
.SH DESCRIPTION
-Converts a string representation of a boolean value into a boolean. Acceptable boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`, `true`/`false`, `on`/`off`.
+Converts a text representation of a boolean value into a boolean. Acceptable boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`, `true`/`false`, `on`/`off`.
+
+.SH ARGUMENTS
.TS
allbox;
diff --git a/man/man3/tomo-Byte.hex.3 b/man/man3/tomo-Byte.hex.3
index 7250d57a..7a7074a3 100644
--- a/man/man3/tomo-Byte.hex.3
+++ b/man/man3/tomo-Byte.hex.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Byte.hex 3 2025-04-19T14:52:07.132576 "Tomo man-pages"
+.TH Byte.hex 3 2025-04-21T14:44:34.257792 "Tomo man-pages"
.SH NAME
-Byte.hex \- Convert a byte to a hexidecimal text representation.
-
+Byte.hex \- convert to hexidecimal
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Byte.hex\ :\ func(byte:\ Byte,\ uppercase:\ Bool\ =\ yes,\ prefix:\ Bool\ =\ no\ ->\ Text)
.fi
-
.SH DESCRIPTION
Convert a byte to a hexidecimal text representation.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Byte.is_between.3 b/man/man3/tomo-Byte.is_between.3
index 7d7bce0a..1e83e09e 100644
--- a/man/man3/tomo-Byte.is_between.3
+++ b/man/man3/tomo-Byte.is_between.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Byte.is_between 3 2025-04-19T14:52:07.132647 "Tomo man-pages"
+.TH Byte.is_between 3 2025-04-21T14:44:34.257869 "Tomo man-pages"
.SH NAME
-Byte.is_between \- Determines if an integer is between two numbers (inclusive).
-
+Byte.is_between \- test if inside a range
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Byte.is_between\ :\ func(x:\ Byte,\ low:\ Byte,\ high:\ Byte\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Determines if an integer is between two numbers (inclusive).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Byte.parse.3 b/man/man3/tomo-Byte.parse.3
index fb674748..80331fee 100644
--- a/man/man3/tomo-Byte.parse.3
+++ b/man/man3/tomo-Byte.parse.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Byte.parse 3 2025-04-19T14:52:07.132692 "Tomo man-pages"
+.TH Byte.parse 3 2025-04-21T14:44:34.257915 "Tomo man-pages"
.SH NAME
-Byte.parse \- Parse a byte literal from text.
-
+Byte.parse \- convert text to a byte
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Byte.parse\ :\ func(text:\ Text\ ->\ Byte?)
.fi
-
.SH DESCRIPTION
Parse a byte literal from text.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Byte.to.3 b/man/man3/tomo-Byte.to.3
index 95405694..7e2dcf11 100644
--- a/man/man3/tomo-Byte.to.3
+++ b/man/man3/tomo-Byte.to.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Byte.to 3 2025-04-19T14:52:07.132731 "Tomo man-pages"
+.TH Byte.to 3 2025-04-21T14:44:34.257958 "Tomo man-pages"
.SH NAME
-Byte.to \- Returns an iterator function that iterates over the range of bytes specified.
-
+Byte.to \- iterate over a range of bytes
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Byte.to\ :\ func(first:\ Byte,\ last:\ Byte,\ step:\ Byte?\ =\ none\ ->\ func(->Byte?))
.fi
-
.SH DESCRIPTION
Returns an iterator function that iterates over the range of bytes specified.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Int.abs.3 b/man/man3/tomo-Int.abs.3
index 3201eb88..3a3d6304 100644
--- a/man/man3/tomo-Int.abs.3
+++ b/man/man3/tomo-Int.abs.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Int.abs 3 2025-04-19T14:52:07.132774 "Tomo man-pages"
+.TH Int.abs 3 2025-04-21T14:44:34.257999 "Tomo man-pages"
.SH NAME
-Int.abs \- Calculates the absolute value of an integer.
-
+Int.abs \- absolute value
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.abs\ :\ func(x:\ Int\ ->\ Int)
.fi
-
.SH DESCRIPTION
Calculates the absolute value of an integer.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Int.choose.3 b/man/man3/tomo-Int.choose.3
index 450b5c71..9d805360 100644
--- a/man/man3/tomo-Int.choose.3
+++ b/man/man3/tomo-Int.choose.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Int.choose 3 2025-04-19T14:52:07.132813 "Tomo man-pages"
+.TH Int.choose 3 2025-04-21T14:44:34.258039 "Tomo man-pages"
.SH NAME
-Int.choose \- Computes the binomial coefficient of the given numbers (the equivalent of `n` choose `k` in combinatorics). This is equal to `n.factorial()/(k.factorial() * (n-k).factorial())`.
-
+Int.choose \- binomial coefficient
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.choose\ :\ func(n:\ Int,\ k:\ Int\ ->\ Int)
.fi
-
.SH DESCRIPTION
Computes the binomial coefficient of the given numbers (the equivalent of `n` choose `k` in combinatorics). This is equal to `n.factorial()/(k.factorial() * (n-k).factorial())`.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Int.clamped.3 b/man/man3/tomo-Int.clamped.3
index bd1a3dd8..f30d7aa4 100644
--- a/man/man3/tomo-Int.clamped.3
+++ b/man/man3/tomo-Int.clamped.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Int.clamped 3 2025-04-19T14:52:07.132851 "Tomo man-pages"
+.TH Int.clamped 3 2025-04-21T14:44:34.258075 "Tomo man-pages"
.SH NAME
-Int.clamped \- Returns the given number clamped between two values so that it is within that range.
-
+Int.clamped \- clamp an integer
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.clamped\ :\ func(x:\ Int,\ low:\ Int,\ high:\ Int\ ->\ Int)
.fi
-
.SH DESCRIPTION
Returns the given number clamped between two values so that it is within that range.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Int.factorial.3 b/man/man3/tomo-Int.factorial.3
index 19d385af..de21d7c5 100644
--- a/man/man3/tomo-Int.factorial.3
+++ b/man/man3/tomo-Int.factorial.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Int.factorial 3 2025-04-19T14:52:07.132896 "Tomo man-pages"
+.TH Int.factorial 3 2025-04-21T14:44:34.258111 "Tomo man-pages"
.SH NAME
-Int.factorial \- Computes the factorial of an integer.
-
+Int.factorial \- factorial
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.factorial\ :\ func(n:\ Int\ ->\ Text)
.fi
-
.SH DESCRIPTION
Computes the factorial of an integer.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Int.format.3 b/man/man3/tomo-Int.format.3
index 2d5eda55..5967b8ec 100644
--- a/man/man3/tomo-Int.format.3
+++ b/man/man3/tomo-Int.format.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Int.format 3 2025-04-19T14:52:07.132937 "Tomo man-pages"
+.TH Int.format 3 2025-04-21T14:44:34.258146 "Tomo man-pages"
.SH NAME
-Int.format \- Formats an integer as a string with a specified number of digits.
-
+Int.format \- text formatting
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.format\ :\ func(i:\ Int,\ digits:\ Int\ =\ 0\ ->\ Text)
.fi
-
.SH DESCRIPTION
Formats an integer as a string with a specified number of digits.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Int.hex.3 b/man/man3/tomo-Int.hex.3
index 9223478e..aadb01e7 100644
--- a/man/man3/tomo-Int.hex.3
+++ b/man/man3/tomo-Int.hex.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Int.hex 3 2025-04-19T14:52:07.132991 "Tomo man-pages"
+.TH Int.hex 3 2025-04-21T14:44:34.258182 "Tomo man-pages"
.SH NAME
-Int.hex \- Converts an integer to its hexadecimal representation.
-
+Int.hex \- convert to hexidecimal
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.hex\ :\ func(i:\ Int,\ digits:\ Int\ =\ 0,\ uppercase:\ Bool\ =\ yes,\ prefix:\ Bool\ =\ yes\ ->\ Text)
.fi
-
.SH DESCRIPTION
Converts an integer to its hexadecimal representation.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Int.is_between.3 b/man/man3/tomo-Int.is_between.3
index 791b81e8..b070d507 100644
--- a/man/man3/tomo-Int.is_between.3
+++ b/man/man3/tomo-Int.is_between.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Int.is_between 3 2025-04-19T14:52:07.133058 "Tomo man-pages"
+.TH Int.is_between 3 2025-04-21T14:44:34.258220 "Tomo man-pages"
.SH NAME
-Int.is_between \- Determines if an integer is between two numbers (inclusive).
-
+Int.is_between \- test if an int is in a range
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.is_between\ :\ func(x:\ Int,\ low:\ Int,\ high:\ Int\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Determines if an integer is between two numbers (inclusive).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Int.is_prime.3 b/man/man3/tomo-Int.is_prime.3
index afc5986f..d4b3f3a1 100644
--- a/man/man3/tomo-Int.is_prime.3
+++ b/man/man3/tomo-Int.is_prime.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Int.is_prime 3 2025-04-19T14:52:07.133116 "Tomo man-pages"
+.TH Int.is_prime 3 2025-04-21T14:44:34.258256 "Tomo man-pages"
.SH NAME
-Int.is_prime \- Determines if an integer is a prime number.
-
+Int.is_prime \- check if an integer is prime
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.is_prime\ :\ func(x:\ Int,\ reps:\ Int\ =\ 50\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Determines if an integer is a prime number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Int.next_prime.3 b/man/man3/tomo-Int.next_prime.3
index ae0a5b9b..3f7fad27 100644
--- a/man/man3/tomo-Int.next_prime.3
+++ b/man/man3/tomo-Int.next_prime.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Int.next_prime 3 2025-04-19T14:52:07.133169 "Tomo man-pages"
+.TH Int.next_prime 3 2025-04-21T14:44:34.258292 "Tomo man-pages"
.SH NAME
-Int.next_prime \- Finds the next prime number greater than the given integer.
-
+Int.next_prime \- get the next prime
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.next_prime\ :\ func(x:\ Int\ ->\ Int)
.fi
-
.SH DESCRIPTION
Finds the next prime number greater than the given integer.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Int.octal.3 b/man/man3/tomo-Int.octal.3
index 819efef4..d72e5e98 100644
--- a/man/man3/tomo-Int.octal.3
+++ b/man/man3/tomo-Int.octal.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Int.octal 3 2025-04-19T14:52:07.133209 "Tomo man-pages"
+.TH Int.octal 3 2025-04-21T14:44:34.258325 "Tomo man-pages"
.SH NAME
-Int.octal \- Converts an integer to its octal representation.
-
+Int.octal \- convert to octal
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.octal\ :\ func(i:\ Int,\ digits:\ Int\ =\ 0,\ prefix:\ Bool\ =\ yes\ ->\ Text)
.fi
-
.SH DESCRIPTION
Converts an integer to its octal representation.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Int.onward.3 b/man/man3/tomo-Int.onward.3
index ac9fe41a..0ed47e25 100644
--- a/man/man3/tomo-Int.onward.3
+++ b/man/man3/tomo-Int.onward.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Int.onward 3 2025-04-19T14:52:07.133251 "Tomo man-pages"
+.TH Int.onward 3 2025-04-21T14:44:34.258360 "Tomo man-pages"
.SH NAME
-Int.onward \- Return an iterator that counts infinitely from the starting integer (with an optional step size).
-
+Int.onward \- iterate from a number onward
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.onward\ :\ func(first:\ Int,\ step:\ Int\ =\ 1\ ->\ Text)
.fi
-
.SH DESCRIPTION
Return an iterator that counts infinitely from the starting integer (with an optional step size).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Int.parse.3 b/man/man3/tomo-Int.parse.3
index f81b4de4..c6ca089e 100644
--- a/man/man3/tomo-Int.parse.3
+++ b/man/man3/tomo-Int.parse.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Int.parse 3 2025-04-19T14:52:07.133310 "Tomo man-pages"
+.TH Int.parse 3 2025-04-21T14:44:34.258409 "Tomo man-pages"
.SH NAME
-Int.parse \- Converts a text representation of an integer into an integer.
-
+Int.parse \- convert text to integer
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.parse\ :\ func(text:\ Text\ ->\ Int?)
.fi
-
.SH DESCRIPTION
Converts a text representation of an integer into an integer.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Int.prev_prime.3 b/man/man3/tomo-Int.prev_prime.3
index 71d9766a..0f41f13e 100644
--- a/man/man3/tomo-Int.prev_prime.3
+++ b/man/man3/tomo-Int.prev_prime.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Int.prev_prime 3 2025-04-19T14:52:07.133351 "Tomo man-pages"
+.TH Int.prev_prime 3 2025-04-21T14:44:34.258448 "Tomo man-pages"
.SH NAME
-Int.prev_prime \- Finds the previous prime number less than the given integer. If there is no previous prime number (i.e. if a number less than `2` is provided), then the function will create a runtime error.
-
+Int.prev_prime \- get the previous prime
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.prev_prime\ :\ func(x:\ Int\ ->\ Int?)
.fi
-
.SH DESCRIPTION
Finds the previous prime number less than the given integer. If there is no previous prime number (i.e. if a number less than `2` is provided), then the function will create a runtime error.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Int.sqrt.3 b/man/man3/tomo-Int.sqrt.3
index c9dcd302..50badcea 100644
--- a/man/man3/tomo-Int.sqrt.3
+++ b/man/man3/tomo-Int.sqrt.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Int.sqrt 3 2025-04-19T14:52:07.133389 "Tomo man-pages"
+.TH Int.sqrt 3 2025-04-21T14:44:34.258485 "Tomo man-pages"
.SH NAME
-Int.sqrt \- Calculates the nearest square root of an integer.
-
+Int.sqrt \- square root
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.sqrt\ :\ func(x:\ Int\ ->\ Int)
.fi
-
.SH DESCRIPTION
Calculates the nearest square root of an integer.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Int.to.3 b/man/man3/tomo-Int.to.3
index be5ef45b..d7fab69c 100644
--- a/man/man3/tomo-Int.to.3
+++ b/man/man3/tomo-Int.to.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Int.to 3 2025-04-19T14:52:07.133424 "Tomo man-pages"
+.TH Int.to 3 2025-04-21T14:44:34.258520 "Tomo man-pages"
.SH NAME
-Int.to \- Returns an iterator function that iterates over the range of numbers specified.
-
+Int.to \- iterate a range of integers
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.to\ :\ func(first:\ Int,\ last:\ Int,\ step:\ Int?\ =\ none\ ->\ func(->Int?))
.fi
-
.SH DESCRIPTION
Returns an iterator function that iterates over the range of numbers specified.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.binary_search.3 b/man/man3/tomo-List.binary_search.3
index 1d6a0c96..6404055f 100644
--- a/man/man3/tomo-List.binary_search.3
+++ b/man/man3/tomo-List.binary_search.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.binary_search 3 2025-04-19T14:52:07.133465 "Tomo man-pages"
+.TH List.binary_search 3 2025-04-21T14:44:34.258558 "Tomo man-pages"
.SH NAME
-List.binary_search \- Performs a binary search on a sorted list.
-
+List.binary_search \- binary search
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.binary_search\ :\ func(list:\ [T],\ by:\ func(x,y:&T->Int32)\ =\ T.compare\ ->\ Int)
.fi
-
.SH DESCRIPTION
Performs a binary search on a sorted list.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.by.3 b/man/man3/tomo-List.by.3
index 61d78a1e..73484cc4 100644
--- a/man/man3/tomo-List.by.3
+++ b/man/man3/tomo-List.by.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.by 3 2025-04-19T14:52:07.133513 "Tomo man-pages"
+.TH List.by 3 2025-04-21T14:44:34.258595 "Tomo man-pages"
.SH NAME
-List.by \- Creates a new list with elements spaced by the specified step value.
-
+List.by \- slice by a step value
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.by\ :\ func(list:\ [T],\ step:\ Int\ ->\ [T])
.fi
-
.SH DESCRIPTION
Creates a new list with elements spaced by the specified step value.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.clear.3 b/man/man3/tomo-List.clear.3
index 8198ddb9..de7c8eae 100644
--- a/man/man3/tomo-List.clear.3
+++ b/man/man3/tomo-List.clear.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.clear 3 2025-04-19T14:52:07.133550 "Tomo man-pages"
+.TH List.clear 3 2025-04-21T14:44:34.258630 "Tomo man-pages"
.SH NAME
-List.clear \- Clears all elements from the list.
-
+List.clear \- clear a list
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.clear\ :\ func(list:\ @[T]\ ->\ Void)
.fi
-
.SH DESCRIPTION
Clears all elements from the list.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.counts.3 b/man/man3/tomo-List.counts.3
index 467f00fa..a70f7d6a 100644
--- a/man/man3/tomo-List.counts.3
+++ b/man/man3/tomo-List.counts.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.counts 3 2025-04-19T14:52:07.133589 "Tomo man-pages"
+.TH List.counts 3 2025-04-21T14:44:34.258662 "Tomo man-pages"
.SH NAME
-List.counts \- Counts the occurrences of each element in the list.
-
+List.counts \- count occurrences
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.counts\ :\ func(list:\ [T]\ ->\ {T=Int})
.fi
-
.SH DESCRIPTION
Counts the occurrences of each element in the list.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.find.3 b/man/man3/tomo-List.find.3
index c147d048..eb7d587a 100644
--- a/man/man3/tomo-List.find.3
+++ b/man/man3/tomo-List.find.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.find 3 2025-04-19T14:52:07.133625 "Tomo man-pages"
+.TH List.find 3 2025-04-21T14:44:34.258694 "Tomo man-pages"
.SH NAME
-List.find \- Finds the index of the first occurrence of an element (if any).
-
+List.find \- find an element's index
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.find\ :\ func(list:\ [T],\ target:\ T\ ->\ Int?)
.fi
-
.SH DESCRIPTION
Finds the index of the first occurrence of an element (if any).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.first.3 b/man/man3/tomo-List.first.3
index 7148cf9d..a8183cc8 100644
--- a/man/man3/tomo-List.first.3
+++ b/man/man3/tomo-List.first.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.first 3 2025-04-19T14:52:07.133684 "Tomo man-pages"
+.TH List.first 3 2025-04-21T14:44:34.258746 "Tomo man-pages"
.SH NAME
-List.first \- Find the index of the first item that matches a predicate function (if any).
-
+List.first \- find an index where a predicate matches
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.first\ :\ func(list:\ [T],\ predicate:\ func(item:&T\ ->\ Bool)\ ->\ Int)
.fi
-
.SH DESCRIPTION
Find the index of the first item that matches a predicate function (if any).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.from.3 b/man/man3/tomo-List.from.3
index 26d76f8a..f100a0c6 100644
--- a/man/man3/tomo-List.from.3
+++ b/man/man3/tomo-List.from.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.from 3 2025-04-19T14:52:07.133724 "Tomo man-pages"
+.TH List.from 3 2025-04-21T14:44:34.258788 "Tomo man-pages"
.SH NAME
-List.from \- Returns a slice of the list starting from a specified index.
-
+List.from \- slice an array from a start index
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.from\ :\ func(list:\ [T],\ first:\ Int\ ->\ [T])
.fi
-
.SH DESCRIPTION
Returns a slice of the list starting from a specified index.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.has.3 b/man/man3/tomo-List.has.3
index 40e08d54..d7543760 100644
--- a/man/man3/tomo-List.has.3
+++ b/man/man3/tomo-List.has.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.has 3 2025-04-19T14:52:07.133762 "Tomo man-pages"
+.TH List.has 3 2025-04-21T14:44:34.258825 "Tomo man-pages"
.SH NAME
-List.has \- Checks if the list has an element.
-
+List.has \- check for member
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.has\ :\ func(list:\ [T],\ target:\ T\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks if the list has an element.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.heap_pop.3 b/man/man3/tomo-List.heap_pop.3
index 646a0506..63060909 100644
--- a/man/man3/tomo-List.heap_pop.3
+++ b/man/man3/tomo-List.heap_pop.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.heap_pop 3 2025-04-19T14:52:07.133799 "Tomo man-pages"
+.TH List.heap_pop 3 2025-04-21T14:44:34.258860 "Tomo man-pages"
.SH NAME
-List.heap_pop \- Removes and returns the top element of a heap or `none` if the list is empty. By default, this is the *minimum* value in the heap.
-
+List.heap_pop \- heap pop
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.heap_pop\ :\ func(list:\ @[T],\ by:\ func(x,y:&T->Int32)\ =\ T.compare\ ->\ T?)
.fi
-
.SH DESCRIPTION
Removes and returns the top element of a heap or `none` if the list is empty. By default, this is the *minimum* value in the heap.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.heap_push.3 b/man/man3/tomo-List.heap_push.3
index 1b871574..ed34c762 100644
--- a/man/man3/tomo-List.heap_push.3
+++ b/man/man3/tomo-List.heap_push.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.heap_push 3 2025-04-19T14:52:07.133837 "Tomo man-pages"
+.TH List.heap_push 3 2025-04-21T14:44:34.258895 "Tomo man-pages"
.SH NAME
-List.heap_push \- Adds an element to the heap and maintains the heap property. By default, this is a *minimum* heap.
-
+List.heap_push \- heap push
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.heap_push\ :\ func(list:\ @[T],\ item:\ T,\ by\ =\ T.compare\ ->\ Void)
.fi
-
.SH DESCRIPTION
Adds an element to the heap and maintains the heap property. By default, this is a *minimum* heap.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.heapify.3 b/man/man3/tomo-List.heapify.3
index 49237423..435935de 100644
--- a/man/man3/tomo-List.heapify.3
+++ b/man/man3/tomo-List.heapify.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.heapify 3 2025-04-19T14:52:07.133878 "Tomo man-pages"
+.TH List.heapify 3 2025-04-21T14:44:34.258932 "Tomo man-pages"
.SH NAME
-List.heapify \- Converts a list into a heap.
-
+List.heapify \- convert a list into a heap
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.heapify\ :\ func(list:\ @[T],\ by:\ func(x,y:&T->Int32)\ =\ T.compare\ ->\ Void)
.fi
-
.SH DESCRIPTION
Converts a list into a heap.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.insert.3 b/man/man3/tomo-List.insert.3
index 378f8d49..0bd7113e 100644
--- a/man/man3/tomo-List.insert.3
+++ b/man/man3/tomo-List.insert.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.insert 3 2025-04-19T14:52:07.133915 "Tomo man-pages"
+.TH List.insert 3 2025-04-21T14:44:34.258966 "Tomo man-pages"
.SH NAME
-List.insert \- Inserts an element at a specified position in the list.
-
+List.insert \- add an item to a list
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.insert\ :\ func(list:\ @[T],\ item:\ T,\ at:\ Int\ =\ 0\ ->\ Void)
.fi
-
.SH DESCRIPTION
Inserts an element at a specified position in the list.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.insert_all.3 b/man/man3/tomo-List.insert_all.3
index 379aeb42..22a7bac1 100644
--- a/man/man3/tomo-List.insert_all.3
+++ b/man/man3/tomo-List.insert_all.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.insert_all 3 2025-04-19T14:52:07.133954 "Tomo man-pages"
+.TH List.insert_all 3 2025-04-21T14:44:34.259003 "Tomo man-pages"
.SH NAME
-List.insert_all \- Inserts a list of items at a specified position in the list.
-
+List.insert_all \- add multiple items to a list
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.insert_all\ :\ func(list:\ @[T],\ items:\ [T],\ at:\ Int\ =\ 0\ ->\ Void)
.fi
-
.SH DESCRIPTION
Inserts a list of items at a specified position in the list.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.pop.3 b/man/man3/tomo-List.pop.3
index 1c48c226..9e2eb099 100644
--- a/man/man3/tomo-List.pop.3
+++ b/man/man3/tomo-List.pop.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.pop 3 2025-04-19T14:52:07.133994 "Tomo man-pages"
+.TH List.pop 3 2025-04-21T14:44:34.259039 "Tomo man-pages"
.SH NAME
-List.pop \- Removes and returns an item from the list. If the given index is present in the list, the item at that index will be removed and the list will become one element shorter.
-
+List.pop \- pop an item from a list
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.pop\ :\ func(list:\ &[T],\ index:\ Int\ =\ -1\ ->\ T?)
.fi
-
.SH DESCRIPTION
Removes and returns an item from the list. If the given index is present in the list, the item at that index will be removed and the list will become one element shorter.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.random.3 b/man/man3/tomo-List.random.3
index f0dcaa24..9da43698 100644
--- a/man/man3/tomo-List.random.3
+++ b/man/man3/tomo-List.random.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.random 3 2025-04-19T14:52:07.134033 "Tomo man-pages"
+.TH List.random 3 2025-04-21T14:44:34.259075 "Tomo man-pages"
.SH NAME
-List.random \- Selects a random element from the list.
-
+List.random \- pick a random element
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.random\ :\ func(list:\ [T],\ random:\ func(min,max:Int64->Int64)?\ =\ none\ ->\ T)
.fi
-
.SH DESCRIPTION
Selects a random element from the list.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.remove_at.3 b/man/man3/tomo-List.remove_at.3
index 62a00c57..7e144cf9 100644
--- a/man/man3/tomo-List.remove_at.3
+++ b/man/man3/tomo-List.remove_at.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.remove_at 3 2025-04-19T14:52:07.134069 "Tomo man-pages"
+.TH List.remove_at 3 2025-04-21T14:44:34.259113 "Tomo man-pages"
.SH NAME
-List.remove_at \- Removes elements from the list starting at a specified index.
-
+List.remove_at \- remove an item by index
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.remove_at\ :\ func(list:\ @[T],\ at:\ Int\ =\ -1,\ count:\ Int\ =\ 1\ ->\ Void)
.fi
-
.SH DESCRIPTION
Removes elements from the list starting at a specified index.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.remove_item.3 b/man/man3/tomo-List.remove_item.3
index 5ba5450f..0a0ec997 100644
--- a/man/man3/tomo-List.remove_item.3
+++ b/man/man3/tomo-List.remove_item.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.remove_item 3 2025-04-19T14:52:07.134107 "Tomo man-pages"
+.TH List.remove_item 3 2025-04-21T14:44:34.259149 "Tomo man-pages"
.SH NAME
-List.remove_item \- Removes all occurrences of a specified item from the list.
-
+List.remove_item \- remove an item by value
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.remove_item\ :\ func(list:\ @[T],\ item:\ T,\ max_count:\ Int\ =\ -1\ ->\ Void)
.fi
-
.SH DESCRIPTION
Removes all occurrences of a specified item from the list.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.reversed.3 b/man/man3/tomo-List.reversed.3
index 1a98e2e3..5eda9cf1 100644
--- a/man/man3/tomo-List.reversed.3
+++ b/man/man3/tomo-List.reversed.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.reversed 3 2025-04-19T14:52:07.134145 "Tomo man-pages"
+.TH List.reversed 3 2025-04-21T14:44:34.259183 "Tomo man-pages"
.SH NAME
-List.reversed \- Returns a reversed slice of the list.
-
+List.reversed \- get a reversed list
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.reversed\ :\ func(list:\ [T]\ ->\ [T])
.fi
-
.SH DESCRIPTION
Returns a reversed slice of the list.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.sample.3 b/man/man3/tomo-List.sample.3
index 1b10467c..449e0531 100644
--- a/man/man3/tomo-List.sample.3
+++ b/man/man3/tomo-List.sample.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.sample 3 2025-04-19T14:52:07.134200 "Tomo man-pages"
+.TH List.sample 3 2025-04-21T14:44:34.259214 "Tomo man-pages"
.SH NAME
-List.sample \- Selects a sample of elements from the list, optionally with weighted probabilities.
-
+List.sample \- weighted random choices
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.sample\ :\ func(list:\ [T],\ count:\ Int,\ weights:\ [Num]?\ =\ ![Num],\ random:\ func(->Num)?\ =\ none\ ->\ [T])
.fi
-
.SH DESCRIPTION
Selects a sample of elements from the list, optionally with weighted probabilities.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.shuffle.3 b/man/man3/tomo-List.shuffle.3
index 295c4dc8..f956c717 100644
--- a/man/man3/tomo-List.shuffle.3
+++ b/man/man3/tomo-List.shuffle.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.shuffle 3 2025-04-19T14:52:07.134248 "Tomo man-pages"
+.TH List.shuffle 3 2025-04-21T14:44:34.259264 "Tomo man-pages"
.SH NAME
-List.shuffle \- Shuffles the elements of the list in place.
-
+List.shuffle \- shuffle a list in place
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.shuffle\ :\ func(list:\ @[T],\ random:\ func(min,max:Int64->Int64)?\ =\ none\ ->\ Void)
.fi
-
.SH DESCRIPTION
Shuffles the elements of the list in place.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.shuffled.3 b/man/man3/tomo-List.shuffled.3
index 436c19cb..88537b6a 100644
--- a/man/man3/tomo-List.shuffled.3
+++ b/man/man3/tomo-List.shuffled.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.shuffled 3 2025-04-19T14:52:07.134287 "Tomo man-pages"
+.TH List.shuffled 3 2025-04-21T14:44:34.259301 "Tomo man-pages"
.SH NAME
-List.shuffled \- Creates a new list with elements shuffled.
-
+List.shuffled \- return a shuffled list
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.shuffled\ :\ func(list:\ [T],\ random:\ func(min,max:Int64->Int64)?\ =\ none\ ->\ [T])
.fi
-
.SH DESCRIPTION
Creates a new list with elements shuffled.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.slice.3 b/man/man3/tomo-List.slice.3
index 04310faa..6028d6ee 100644
--- a/man/man3/tomo-List.slice.3
+++ b/man/man3/tomo-List.slice.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.slice 3 2025-04-19T14:52:07.134326 "Tomo man-pages"
+.TH List.slice 3 2025-04-21T14:44:34.259335 "Tomo man-pages"
.SH NAME
-List.slice \- Returns a slice of the list spanning the given indices (inclusive).
-
+List.slice \- get a slice of a list
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.slice\ :\ func(list:\ [T],\ from:\ Int,\ to:\ Int\ ->\ [T])
.fi
-
.SH DESCRIPTION
Returns a slice of the list spanning the given indices (inclusive).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.sort.3 b/man/man3/tomo-List.sort.3
index e1384ce8..65b25f3d 100644
--- a/man/man3/tomo-List.sort.3
+++ b/man/man3/tomo-List.sort.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.sort 3 2025-04-19T14:52:07.134364 "Tomo man-pages"
+.TH List.sort 3 2025-04-21T14:44:34.259371 "Tomo man-pages"
.SH NAME
-List.sort \- Sorts the elements of the list in place in ascending order (small to large).
-
+List.sort \- sort a list
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.sort\ :\ func(list:\ @[T],\ by\ =\ T.compare\ ->\ Void)
.fi
-
.SH DESCRIPTION
Sorts the elements of the list in place in ascending order (small to large).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.sorted.3 b/man/man3/tomo-List.sorted.3
index 8f05dee3..e37ab8cd 100644
--- a/man/man3/tomo-List.sorted.3
+++ b/man/man3/tomo-List.sorted.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.sorted 3 2025-04-19T14:52:07.134401 "Tomo man-pages"
+.TH List.sorted 3 2025-04-21T14:44:34.259407 "Tomo man-pages"
.SH NAME
-List.sorted \- Creates a new list with elements sorted.
-
+List.sorted \- sorted copy of a list
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.sorted\ :\ func(list:\ [T],\ by\ =\ T.compare\ ->\ [T])
.fi
-
.SH DESCRIPTION
Creates a new list with elements sorted.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.to.3 b/man/man3/tomo-List.to.3
index b856363d..5e8eccd0 100644
--- a/man/man3/tomo-List.to.3
+++ b/man/man3/tomo-List.to.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.to 3 2025-04-19T14:52:07.134439 "Tomo man-pages"
+.TH List.to 3 2025-04-21T14:44:34.259442 "Tomo man-pages"
.SH NAME
-List.to \- Returns a slice of the list from the start of the original list up to a specified index (inclusive).
-
+List.to \- slice a list to an end index
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.to\ :\ func(list:\ [T],\ last:\ Int\ ->\ [T])
.fi
-
.SH DESCRIPTION
Returns a slice of the list from the start of the original list up to a specified index (inclusive).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-List.unique.3 b/man/man3/tomo-List.unique.3
index 8b1c8dd5..c57a849e 100644
--- a/man/man3/tomo-List.unique.3
+++ b/man/man3/tomo-List.unique.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH List.unique 3 2025-04-19T14:52:07.134525 "Tomo man-pages"
+.TH List.unique 3 2025-04-21T14:44:34.259477 "Tomo man-pages"
.SH NAME
-List.unique \- Returns a Set that contains the unique elements of the list.
-
+List.unique \- convert a list to a set
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI List.unique\ :\ func(list:\ [T]\ ->\ |T|)
.fi
-
.SH DESCRIPTION
Returns a Set that contains the unique elements of the list.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.1_PI.3 b/man/man3/tomo-Num.1_PI.3
index ac21ab82..4c272db1 100644
--- a/man/man3/tomo-Num.1_PI.3
+++ b/man/man3/tomo-Num.1_PI.3
@@ -2,17 +2,16 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.1_PI 3 2025-04-19T14:52:07.136710 "Tomo man-pages"
+.TH Num.1_PI 3 2025-04-21T14:44:34.261434 "Tomo man-pages"
.SH NAME
-Num.1_PI \- The constant $\frac{1}{\pi}$.
-
+Num.1_PI \- 1/pi
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.1_PI\ :\ Num
.fi
-
.SH DESCRIPTION
The constant $\frac{1}{\pi}$.
+
diff --git a/man/man3/tomo-Num.2_PI.3 b/man/man3/tomo-Num.2_PI.3
index cd47a0fd..d3ed3eb1 100644
--- a/man/man3/tomo-Num.2_PI.3
+++ b/man/man3/tomo-Num.2_PI.3
@@ -2,17 +2,16 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.2_PI 3 2025-04-19T14:52:07.136743 "Tomo man-pages"
+.TH Num.2_PI 3 2025-04-21T14:44:34.261468 "Tomo man-pages"
.SH NAME
-Num.2_PI \- The constant $2 \times \pi$.
-
+Num.2_PI \- 2*pi
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.2_PI\ :\ Num
.fi
-
.SH DESCRIPTION
The constant $2 \times \pi$.
+
diff --git a/man/man3/tomo-Num.2_SQRTPI.3 b/man/man3/tomo-Num.2_SQRTPI.3
index 73fc25df..6026d8cc 100644
--- a/man/man3/tomo-Num.2_SQRTPI.3
+++ b/man/man3/tomo-Num.2_SQRTPI.3
@@ -2,17 +2,16 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.2_SQRTPI 3 2025-04-19T14:52:07.136776 "Tomo man-pages"
+.TH Num.2_SQRTPI 3 2025-04-21T14:44:34.261499 "Tomo man-pages"
.SH NAME
-Num.2_SQRTPI \- The constant $2 \times \sqrt{\pi}$.
-
+Num.2_SQRTPI \- 2*sqrt(pi)
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.2_SQRTPI\ :\ Num
.fi
-
.SH DESCRIPTION
The constant $2 \times \sqrt{\pi}$.
+
diff --git a/man/man3/tomo-Num.E.3 b/man/man3/tomo-Num.E.3
index 89f83804..99edcecf 100644
--- a/man/man3/tomo-Num.E.3
+++ b/man/man3/tomo-Num.E.3
@@ -2,17 +2,16 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.E 3 2025-04-19T14:52:07.136808 "Tomo man-pages"
+.TH Num.E 3 2025-04-21T14:44:34.261532 "Tomo man-pages"
.SH NAME
-Num.E \- The base of the natural logarithm ($e$).
-
+Num.E \- Euler's constant
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.E\ :\ Num
.fi
-
.SH DESCRIPTION
The base of the natural logarithm ($e$).
+
diff --git a/man/man3/tomo-Num.INF.3 b/man/man3/tomo-Num.INF.3
index c6260372..c761ae6e 100644
--- a/man/man3/tomo-Num.INF.3
+++ b/man/man3/tomo-Num.INF.3
@@ -2,17 +2,16 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.INF 3 2025-04-19T14:52:07.136839 "Tomo man-pages"
+.TH Num.INF 3 2025-04-21T14:44:34.261561 "Tomo man-pages"
.SH NAME
-Num.INF \- Positive infinity.
-
+Num.INF \- infinity
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.INF\ :\ Num
.fi
-
.SH DESCRIPTION
Positive infinity.
+
diff --git a/man/man3/tomo-Num.LN10.3 b/man/man3/tomo-Num.LN10.3
index 8919add9..9f355d4c 100644
--- a/man/man3/tomo-Num.LN10.3
+++ b/man/man3/tomo-Num.LN10.3
@@ -2,17 +2,16 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.LN10 3 2025-04-19T14:52:07.136870 "Tomo man-pages"
+.TH Num.LN10 3 2025-04-21T14:44:34.261603 "Tomo man-pages"
.SH NAME
-Num.LN10 \- The natural logarithm of 10.
-
+Num.LN10 \- log(10)
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.LN10\ :\ Num
.fi
-
.SH DESCRIPTION
The natural logarithm of 10.
+
diff --git a/man/man3/tomo-Num.LN2.3 b/man/man3/tomo-Num.LN2.3
index 5314ebb4..9df29405 100644
--- a/man/man3/tomo-Num.LN2.3
+++ b/man/man3/tomo-Num.LN2.3
@@ -2,17 +2,16 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.LN2 3 2025-04-19T14:52:07.136901 "Tomo man-pages"
+.TH Num.LN2 3 2025-04-21T14:44:34.261635 "Tomo man-pages"
.SH NAME
-Num.LN2 \- The natural logarithm of 2.
-
+Num.LN2 \- log(2)
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.LN2\ :\ Num
.fi
-
.SH DESCRIPTION
The natural logarithm of 2.
+
diff --git a/man/man3/tomo-Num.LOG2E.3 b/man/man3/tomo-Num.LOG2E.3
index 536c3bbd..80813fe8 100644
--- a/man/man3/tomo-Num.LOG2E.3
+++ b/man/man3/tomo-Num.LOG2E.3
@@ -2,17 +2,16 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.LOG2E 3 2025-04-19T14:52:07.136931 "Tomo man-pages"
+.TH Num.LOG2E 3 2025-04-21T14:44:34.261665 "Tomo man-pages"
.SH NAME
-Num.LOG2E \- The base 2 logarithm of $e$
-
+Num.LOG2E \- log_2(e)
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.LOG2E\ :\ Num
.fi
-
.SH DESCRIPTION
The base 2 logarithm of $e$
+
diff --git a/man/man3/tomo-Num.PI.3 b/man/man3/tomo-Num.PI.3
index a138113e..a1284f5a 100644
--- a/man/man3/tomo-Num.PI.3
+++ b/man/man3/tomo-Num.PI.3
@@ -2,17 +2,16 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.PI 3 2025-04-19T14:52:07.136961 "Tomo man-pages"
+.TH Num.PI 3 2025-04-21T14:44:34.261694 "Tomo man-pages"
.SH NAME
-Num.PI \- Pi ($\pi$).
-
+Num.PI \- pi
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.PI\ :\ Num
.fi
-
.SH DESCRIPTION
Pi ($\pi$).
+
diff --git a/man/man3/tomo-Num.PI_2.3 b/man/man3/tomo-Num.PI_2.3
index 52f77ff4..f0a1278a 100644
--- a/man/man3/tomo-Num.PI_2.3
+++ b/man/man3/tomo-Num.PI_2.3
@@ -2,17 +2,16 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.PI_2 3 2025-04-19T14:52:07.136992 "Tomo man-pages"
+.TH Num.PI_2 3 2025-04-21T14:44:34.261725 "Tomo man-pages"
.SH NAME
-Num.PI_2 \- $\frac{\pi}{2}$
-
+Num.PI_2 \- pi/2
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.PI_2\ :\ Num
.fi
-
.SH DESCRIPTION
$\frac{\pi}{2}$
+
diff --git a/man/man3/tomo-Num.PI_4.3 b/man/man3/tomo-Num.PI_4.3
index 66166cd3..12edce84 100644
--- a/man/man3/tomo-Num.PI_4.3
+++ b/man/man3/tomo-Num.PI_4.3
@@ -2,17 +2,16 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.PI_4 3 2025-04-19T14:52:07.137022 "Tomo man-pages"
+.TH Num.PI_4 3 2025-04-21T14:44:34.261766 "Tomo man-pages"
.SH NAME
-Num.PI_4 \- $\frac{\pi}{4}$
-
+Num.PI_4 \- pi/4
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.PI_4\ :\ Num
.fi
-
.SH DESCRIPTION
$\frac{\pi}{4}$
+
diff --git a/man/man3/tomo-Num.SQRT1_2.3 b/man/man3/tomo-Num.SQRT1_2.3
index 31695b74..51083ddd 100644
--- a/man/man3/tomo-Num.SQRT1_2.3
+++ b/man/man3/tomo-Num.SQRT1_2.3
@@ -2,17 +2,16 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.SQRT1_2 3 2025-04-19T14:52:07.137052 "Tomo man-pages"
+.TH Num.SQRT1_2 3 2025-04-21T14:44:34.261796 "Tomo man-pages"
.SH NAME
-Num.SQRT1_2 \- $\sqrt{\frac{1}{2}}$
-
+Num.SQRT1_2 \- sqrt(1/2)
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.SQRT1_2\ :\ Num
.fi
-
.SH DESCRIPTION
$\sqrt{\frac{1}{2}}$
+
diff --git a/man/man3/tomo-Num.SQRT2.3 b/man/man3/tomo-Num.SQRT2.3
index dac4a704..1a7f112e 100644
--- a/man/man3/tomo-Num.SQRT2.3
+++ b/man/man3/tomo-Num.SQRT2.3
@@ -2,17 +2,16 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.SQRT2 3 2025-04-19T14:52:07.137081 "Tomo man-pages"
+.TH Num.SQRT2 3 2025-04-21T14:44:34.261828 "Tomo man-pages"
.SH NAME
-Num.SQRT2 \- $\sqrt{2}$
-
+Num.SQRT2 \- sqrt(2)
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.SQRT2\ :\ Num
.fi
-
.SH DESCRIPTION
$\sqrt{2}$
+
diff --git a/man/man3/tomo-Num.TAU.3 b/man/man3/tomo-Num.TAU.3
index 663d615e..462f3a84 100644
--- a/man/man3/tomo-Num.TAU.3
+++ b/man/man3/tomo-Num.TAU.3
@@ -2,17 +2,16 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.TAU 3 2025-04-19T14:52:07.137113 "Tomo man-pages"
+.TH Num.TAU 3 2025-04-21T14:44:34.261871 "Tomo man-pages"
.SH NAME
-Num.TAU \- Tau ($2 \times \pi$)
-
+Num.TAU \- 2*pi
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.TAU\ :\ Num
.fi
-
.SH DESCRIPTION
Tau ($2 \times \pi$)
+
diff --git a/man/man3/tomo-Num.abs.3 b/man/man3/tomo-Num.abs.3
index aa398693..9a8ebe65 100644
--- a/man/man3/tomo-Num.abs.3
+++ b/man/man3/tomo-Num.abs.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.abs 3 2025-04-19T14:52:07.134564 "Tomo man-pages"
+.TH Num.abs 3 2025-04-21T14:44:34.259511 "Tomo man-pages"
.SH NAME
-Num.abs \- Calculates the absolute value of a number.
-
+Num.abs \- absolute value
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.abs\ :\ func(n:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Calculates the absolute value of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.acos.3 b/man/man3/tomo-Num.acos.3
index 69ccffb4..6acf1147 100644
--- a/man/man3/tomo-Num.acos.3
+++ b/man/man3/tomo-Num.acos.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.acos 3 2025-04-19T14:52:07.134605 "Tomo man-pages"
+.TH Num.acos 3 2025-04-21T14:44:34.259544 "Tomo man-pages"
.SH NAME
-Num.acos \- Computes the arc cosine of a number.
-
+Num.acos \- arc cosine
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.acos\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the arc cosine of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.acosh.3 b/man/man3/tomo-Num.acosh.3
index 5e261c16..eecd0bc0 100644
--- a/man/man3/tomo-Num.acosh.3
+++ b/man/man3/tomo-Num.acosh.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.acosh 3 2025-04-19T14:52:07.134647 "Tomo man-pages"
+.TH Num.acosh 3 2025-04-21T14:44:34.259581 "Tomo man-pages"
.SH NAME
-Num.acosh \- Computes the inverse hyperbolic cosine of a number.
-
+Num.acosh \- arc hyperbolic cosine
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.acosh\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the inverse hyperbolic cosine of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.asin.3 b/man/man3/tomo-Num.asin.3
index b77cbce7..ddb14bd8 100644
--- a/man/man3/tomo-Num.asin.3
+++ b/man/man3/tomo-Num.asin.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.asin 3 2025-04-19T14:52:07.134688 "Tomo man-pages"
+.TH Num.asin 3 2025-04-21T14:44:34.259614 "Tomo man-pages"
.SH NAME
-Num.asin \- Computes the arc sine of a number.
-
+Num.asin \- arc sine
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.asin\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the arc sine of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.asinh.3 b/man/man3/tomo-Num.asinh.3
index 1d48d8d6..ea83d208 100644
--- a/man/man3/tomo-Num.asinh.3
+++ b/man/man3/tomo-Num.asinh.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.asinh 3 2025-04-19T14:52:07.134724 "Tomo man-pages"
+.TH Num.asinh 3 2025-04-21T14:44:34.259647 "Tomo man-pages"
.SH NAME
-Num.asinh \- Computes the inverse hyperbolic sine of a number.
-
+Num.asinh \- arc hyperbolic sine
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.asinh\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the inverse hyperbolic sine of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.atan.3 b/man/man3/tomo-Num.atan.3
index a9875caa..987726c3 100644
--- a/man/man3/tomo-Num.atan.3
+++ b/man/man3/tomo-Num.atan.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.atan 3 2025-04-19T14:52:07.134758 "Tomo man-pages"
+.TH Num.atan 3 2025-04-21T14:44:34.259680 "Tomo man-pages"
.SH NAME
-Num.atan \- Computes the arc tangent of a number.
-
+Num.atan \- arc tangent
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.atan\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the arc tangent of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.atan2.3 b/man/man3/tomo-Num.atan2.3
index a58c0e91..01afbc4b 100644
--- a/man/man3/tomo-Num.atan2.3
+++ b/man/man3/tomo-Num.atan2.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.atan2 3 2025-04-19T14:52:07.134792 "Tomo man-pages"
+.TH Num.atan2 3 2025-04-21T14:44:34.259712 "Tomo man-pages"
.SH NAME
-Num.atan2 \- Computes the arc tangent of the quotient of two numbers.
-
+Num.atan2 \- arc tangent from 2 variables
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.atan2\ :\ func(x:\ Num,\ y:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the arc tangent of the quotient of two numbers.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.atanh.3 b/man/man3/tomo-Num.atanh.3
index 4d1b5402..62b33b14 100644
--- a/man/man3/tomo-Num.atanh.3
+++ b/man/man3/tomo-Num.atanh.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.atanh 3 2025-04-19T14:52:07.134852 "Tomo man-pages"
+.TH Num.atanh 3 2025-04-21T14:44:34.259769 "Tomo man-pages"
.SH NAME
-Num.atanh \- Computes the inverse hyperbolic tangent of a number.
-
+Num.atanh \- arc hyperbolic tangent.
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.atanh\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the inverse hyperbolic tangent of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.cbrt.3 b/man/man3/tomo-Num.cbrt.3
index 2f1ae127..fb05a150 100644
--- a/man/man3/tomo-Num.cbrt.3
+++ b/man/man3/tomo-Num.cbrt.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.cbrt 3 2025-04-19T14:52:07.134894 "Tomo man-pages"
+.TH Num.cbrt 3 2025-04-21T14:44:34.259807 "Tomo man-pages"
.SH NAME
-Num.cbrt \- Computes the cube root of a number.
-
+Num.cbrt \- cube root
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.cbrt\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the cube root of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.ceil.3 b/man/man3/tomo-Num.ceil.3
index 8d438932..d324ede2 100644
--- a/man/man3/tomo-Num.ceil.3
+++ b/man/man3/tomo-Num.ceil.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.ceil 3 2025-04-19T14:52:07.134930 "Tomo man-pages"
+.TH Num.ceil 3 2025-04-21T14:44:34.259842 "Tomo man-pages"
.SH NAME
-Num.ceil \- Rounds a number up to the nearest integer.
-
+Num.ceil \- ceiling function
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.ceil\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Rounds a number up to the nearest integer.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.clamped.3 b/man/man3/tomo-Num.clamped.3
index d781ac92..7455a6ba 100644
--- a/man/man3/tomo-Num.clamped.3
+++ b/man/man3/tomo-Num.clamped.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.clamped 3 2025-04-19T14:52:07.134967 "Tomo man-pages"
+.TH Num.clamped 3 2025-04-21T14:44:34.259874 "Tomo man-pages"
.SH NAME
-Num.clamped \- Returns the given number clamped between two values so that it is within that range.
-
+Num.clamped \- clamp a number
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.clamped\ :\ func(x:\ Num,\ low:\ Num,\ high:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Returns the given number clamped between two values so that it is within that range.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.copysign.3 b/man/man3/tomo-Num.copysign.3
index 98c83cd8..9d122cfc 100644
--- a/man/man3/tomo-Num.copysign.3
+++ b/man/man3/tomo-Num.copysign.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.copysign 3 2025-04-19T14:52:07.135004 "Tomo man-pages"
+.TH Num.copysign 3 2025-04-21T14:44:34.259909 "Tomo man-pages"
.SH NAME
-Num.copysign \- Copies the sign of one number to another.
-
+Num.copysign \- copy a number's sign
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.copysign\ :\ func(x:\ Num,\ y:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Copies the sign of one number to another.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.cos.3 b/man/man3/tomo-Num.cos.3
index ab5b5dca..bbd6c6ab 100644
--- a/man/man3/tomo-Num.cos.3
+++ b/man/man3/tomo-Num.cos.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.cos 3 2025-04-19T14:52:07.135041 "Tomo man-pages"
+.TH Num.cos 3 2025-04-21T14:44:34.259943 "Tomo man-pages"
.SH NAME
-Num.cos \- Computes the cosine of a number (angle in radians).
-
+Num.cos \- cosine
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.cos\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the cosine of a number (angle in radians).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.cosh.3 b/man/man3/tomo-Num.cosh.3
index e6579af7..f2d890a9 100644
--- a/man/man3/tomo-Num.cosh.3
+++ b/man/man3/tomo-Num.cosh.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.cosh 3 2025-04-19T14:52:07.135077 "Tomo man-pages"
+.TH Num.cosh 3 2025-04-21T14:44:34.259975 "Tomo man-pages"
.SH NAME
-Num.cosh \- Computes the hyperbolic cosine of a number.
-
+Num.cosh \- hyperbolic cosine
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.cosh\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the hyperbolic cosine of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.erf.3 b/man/man3/tomo-Num.erf.3
index 3cb681c3..0a3eb255 100644
--- a/man/man3/tomo-Num.erf.3
+++ b/man/man3/tomo-Num.erf.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.erf 3 2025-04-19T14:52:07.135112 "Tomo man-pages"
+.TH Num.erf 3 2025-04-21T14:44:34.260007 "Tomo man-pages"
.SH NAME
-Num.erf \- Computes the error function of a number.
-
+Num.erf \- error function
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.erf\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the error function of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.erfc.3 b/man/man3/tomo-Num.erfc.3
index 27f131ed..81af5dd9 100644
--- a/man/man3/tomo-Num.erfc.3
+++ b/man/man3/tomo-Num.erfc.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.erfc 3 2025-04-19T14:52:07.135148 "Tomo man-pages"
+.TH Num.erfc 3 2025-04-21T14:44:34.260039 "Tomo man-pages"
.SH NAME
-Num.erfc \- Computes the complementary error function of a number.
-
+Num.erfc \- complimentary error function
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.erfc\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the complementary error function of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.exp.3 b/man/man3/tomo-Num.exp.3
index fff48f9d..65e10e2e 100644
--- a/man/man3/tomo-Num.exp.3
+++ b/man/man3/tomo-Num.exp.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.exp 3 2025-04-19T14:52:07.135183 "Tomo man-pages"
+.TH Num.exp 3 2025-04-21T14:44:34.260082 "Tomo man-pages"
.SH NAME
-Num.exp \- Computes the exponential function $e^x$ for a number.
-
+Num.exp \- base-e exponentiation
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.exp\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the exponential function $e^x$ for a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.exp2.3 b/man/man3/tomo-Num.exp2.3
index 42d25ab5..bd123d6e 100644
--- a/man/man3/tomo-Num.exp2.3
+++ b/man/man3/tomo-Num.exp2.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.exp2 3 2025-04-19T14:52:07.135220 "Tomo man-pages"
+.TH Num.exp2 3 2025-04-21T14:44:34.260119 "Tomo man-pages"
.SH NAME
-Num.exp2 \- Computes $2^x$ for a number.
-
+Num.exp2 \- base-2 exponentiation
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.exp2\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes $2^x$ for a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.expm1.3 b/man/man3/tomo-Num.expm1.3
index 1acdd71e..4f77d95e 100644
--- a/man/man3/tomo-Num.expm1.3
+++ b/man/man3/tomo-Num.expm1.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.expm1 3 2025-04-19T14:52:07.135255 "Tomo man-pages"
+.TH Num.expm1 3 2025-04-21T14:44:34.260152 "Tomo man-pages"
.SH NAME
-Num.expm1 \- Computes $e^x - 1$ for a number.
-
+Num.expm1 \- base-e exponential minus 1
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.expm1\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes $e^x - 1$ for a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.fdim.3 b/man/man3/tomo-Num.fdim.3
index 2f99f49b..8dc51351 100644
--- a/man/man3/tomo-Num.fdim.3
+++ b/man/man3/tomo-Num.fdim.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.fdim 3 2025-04-19T14:52:07.135290 "Tomo man-pages"
+.TH Num.fdim 3 2025-04-21T14:44:34.260190 "Tomo man-pages"
.SH NAME
-Num.fdim \- Computes the positive difference between two numbers.
-
+Num.fdim \- positive difference
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.fdim\ :\ func(x:\ Num,\ y:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the positive difference between two numbers.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.floor.3 b/man/man3/tomo-Num.floor.3
index 746cdd70..a5cc4069 100644
--- a/man/man3/tomo-Num.floor.3
+++ b/man/man3/tomo-Num.floor.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.floor 3 2025-04-19T14:52:07.135329 "Tomo man-pages"
+.TH Num.floor 3 2025-04-21T14:44:34.260225 "Tomo man-pages"
.SH NAME
-Num.floor \- Rounds a number down to the nearest integer.
-
+Num.floor \- floor function
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.floor\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Rounds a number down to the nearest integer.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.format.3 b/man/man3/tomo-Num.format.3
index 5c356369..f9306215 100644
--- a/man/man3/tomo-Num.format.3
+++ b/man/man3/tomo-Num.format.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.format 3 2025-04-19T14:52:07.135364 "Tomo man-pages"
+.TH Num.format 3 2025-04-21T14:44:34.260262 "Tomo man-pages"
.SH NAME
-Num.format \- Formats a number as a text with a specified precision.
-
+Num.format \- convert a number to text
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.format\ :\ func(n:\ Num,\ precision:\ Int\ =\ 0\ ->\ Text)
.fi
-
.SH DESCRIPTION
Formats a number as a text with a specified precision.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.hypot.3 b/man/man3/tomo-Num.hypot.3
index ee41fbe2..faae1b22 100644
--- a/man/man3/tomo-Num.hypot.3
+++ b/man/man3/tomo-Num.hypot.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.hypot 3 2025-04-19T14:52:07.135403 "Tomo man-pages"
+.TH Num.hypot 3 2025-04-21T14:44:34.260299 "Tomo man-pages"
.SH NAME
-Num.hypot \- Computes the Euclidean norm, $\sqrt{x^2 + y^2}$, of two numbers.
-
+Num.hypot \- Euclidean distance function
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.hypot\ :\ func(x:\ Num,\ y:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the Euclidean norm, $\sqrt{x^2 + y^2}$, of two numbers.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.is_between.3 b/man/man3/tomo-Num.is_between.3
index c625093a..8464075d 100644
--- a/man/man3/tomo-Num.is_between.3
+++ b/man/man3/tomo-Num.is_between.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.is_between 3 2025-04-19T14:52:07.135471 "Tomo man-pages"
+.TH Num.is_between 3 2025-04-21T14:44:34.260375 "Tomo man-pages"
.SH NAME
-Num.is_between \- Determines if a number is between two numbers (inclusive).
-
+Num.is_between \- check if a number is in a range
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.is_between\ :\ func(x:\ Num,\ low:\ Num,\ high:\ Num\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Determines if a number is between two numbers (inclusive).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.isfinite.3 b/man/man3/tomo-Num.isfinite.3
index ad49f967..e4f6c1f5 100644
--- a/man/man3/tomo-Num.isfinite.3
+++ b/man/man3/tomo-Num.isfinite.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.isfinite 3 2025-04-19T14:52:07.135437 "Tomo man-pages"
+.TH Num.isfinite 3 2025-04-21T14:44:34.260337 "Tomo man-pages"
.SH NAME
-Num.isfinite \- Checks if a number is finite.
-
+Num.isfinite \- check for finite number
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.isfinite\ :\ func(n:\ Num\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks if a number is finite.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.isinf.3 b/man/man3/tomo-Num.isinf.3
index 5cf61dfd..84653372 100644
--- a/man/man3/tomo-Num.isinf.3
+++ b/man/man3/tomo-Num.isinf.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.isinf 3 2025-04-19T14:52:07.135533 "Tomo man-pages"
+.TH Num.isinf 3 2025-04-21T14:44:34.260415 "Tomo man-pages"
.SH NAME
-Num.isinf \- Checks if a number is infinite.
-
+Num.isinf \- check for infinite number
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.isinf\ :\ func(n:\ Num\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks if a number is infinite.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.j0.3 b/man/man3/tomo-Num.j0.3
index c82ec4f7..91413f5f 100644
--- a/man/man3/tomo-Num.j0.3
+++ b/man/man3/tomo-Num.j0.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.j0 3 2025-04-19T14:52:07.135570 "Tomo man-pages"
+.TH Num.j0 3 2025-04-21T14:44:34.260451 "Tomo man-pages"
.SH NAME
-Num.j0 \- Computes the Bessel function of the first kind of order 0.
-
+Num.j0 \- Bessel function
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.j0\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the Bessel function of the first kind of order 0.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.j1.3 b/man/man3/tomo-Num.j1.3
index 8b44859f..d0e0f125 100644
--- a/man/man3/tomo-Num.j1.3
+++ b/man/man3/tomo-Num.j1.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.j1 3 2025-04-19T14:52:07.135605 "Tomo man-pages"
+.TH Num.j1 3 2025-04-21T14:44:34.260500 "Tomo man-pages"
.SH NAME
-Num.j1 \- Computes the Bessel function of the first kind of order 1.
-
+Num.j1 \- Bessel function
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.j1\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the Bessel function of the first kind of order 1.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.log.3 b/man/man3/tomo-Num.log.3
index 5d0d1a2b..9b601004 100644
--- a/man/man3/tomo-Num.log.3
+++ b/man/man3/tomo-Num.log.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.log 3 2025-04-19T14:52:07.135641 "Tomo man-pages"
+.TH Num.log 3 2025-04-21T14:44:34.260541 "Tomo man-pages"
.SH NAME
-Num.log \- Computes the natural logarithm (base $e$) of a number.
-
+Num.log \- natural logarithm
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.log\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the natural logarithm (base $e$) of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.log10.3 b/man/man3/tomo-Num.log10.3
index 7db50f7e..baa5e194 100644
--- a/man/man3/tomo-Num.log10.3
+++ b/man/man3/tomo-Num.log10.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.log10 3 2025-04-19T14:52:07.135675 "Tomo man-pages"
+.TH Num.log10 3 2025-04-21T14:44:34.260578 "Tomo man-pages"
.SH NAME
-Num.log10 \- Computes the base-10 logarithm of a number.
-
+Num.log10 \- logarithm base-10
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.log10\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the base-10 logarithm of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.log1p.3 b/man/man3/tomo-Num.log1p.3
index 7066ae4b..e6e41be7 100644
--- a/man/man3/tomo-Num.log1p.3
+++ b/man/man3/tomo-Num.log1p.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.log1p 3 2025-04-19T14:52:07.135711 "Tomo man-pages"
+.TH Num.log1p 3 2025-04-21T14:44:34.260616 "Tomo man-pages"
.SH NAME
-Num.log1p \- Computes $\log(1 + x)$ for a number.
-
+Num.log1p \- logarithm of 1 plus x
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.log1p\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes $\log(1 + x)$ for a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.log2.3 b/man/man3/tomo-Num.log2.3
index f3d6ca98..6f6f956b 100644
--- a/man/man3/tomo-Num.log2.3
+++ b/man/man3/tomo-Num.log2.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.log2 3 2025-04-19T14:52:07.135820 "Tomo man-pages"
+.TH Num.log2 3 2025-04-21T14:44:34.260655 "Tomo man-pages"
.SH NAME
-Num.log2 \- Computes the base-2 logarithm of a number.
-
+Num.log2 \- logarithm base-2
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.log2\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the base-2 logarithm of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.logb.3 b/man/man3/tomo-Num.logb.3
index e4493473..3970bf59 100644
--- a/man/man3/tomo-Num.logb.3
+++ b/man/man3/tomo-Num.logb.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.logb 3 2025-04-19T14:52:07.135864 "Tomo man-pages"
+.TH Num.logb 3 2025-04-21T14:44:34.260692 "Tomo man-pages"
.SH NAME
-Num.logb \- Computes the binary exponent (base-2 logarithm) of a number.
-
+Num.logb \- exponent of a floating point value
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.logb\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the binary exponent (base-2 logarithm) of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.mix.3 b/man/man3/tomo-Num.mix.3
index 63dec99c..092f66f6 100644
--- a/man/man3/tomo-Num.mix.3
+++ b/man/man3/tomo-Num.mix.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.mix 3 2025-04-19T14:52:07.135902 "Tomo man-pages"
+.TH Num.mix 3 2025-04-21T14:44:34.260731 "Tomo man-pages"
.SH NAME
-Num.mix \- Interpolates between two numbers based on a given amount.
-
+Num.mix \- mix two numbers by an amount
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.mix\ :\ func(amount:\ Num,\ x:\ Num,\ y:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Interpolates between two numbers based on a given amount.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.near.3 b/man/man3/tomo-Num.near.3
index a4e86160..dc777bd5 100644
--- a/man/man3/tomo-Num.near.3
+++ b/man/man3/tomo-Num.near.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.near 3 2025-04-19T14:52:07.135971 "Tomo man-pages"
+.TH Num.near 3 2025-04-21T14:44:34.260779 "Tomo man-pages"
.SH NAME
-Num.near \- Checks if two numbers are approximately equal within specified tolerances. If two numbers are within an absolute difference or the ratio between the two is small enough, they are considered near each other.
-
+Num.near \- check if two numbers are near each other
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.near\ :\ func(x:\ Num,\ y:\ Num,\ ratio:\ Num\ =\ 1e-9,\ min_epsilon:\ Num\ =\ 1e-9\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks if two numbers are approximately equal within specified tolerances. If two numbers are within an absolute difference or the ratio between the two is small enough, they are considered near each other.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.nextafter.3 b/man/man3/tomo-Num.nextafter.3
index d09998dd..fdba508b 100644
--- a/man/man3/tomo-Num.nextafter.3
+++ b/man/man3/tomo-Num.nextafter.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.nextafter 3 2025-04-19T14:52:07.136023 "Tomo man-pages"
+.TH Num.nextafter 3 2025-04-21T14:44:34.260828 "Tomo man-pages"
.SH NAME
-Num.nextafter \- Computes the next representable value after a given number towards a specified direction.
-
+Num.nextafter \- next floating point number
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.nextafter\ :\ func(x:\ Num,\ y:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the next representable value after a given number towards a specified direction.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.parse.3 b/man/man3/tomo-Num.parse.3
index 37a14700..81b6b111 100644
--- a/man/man3/tomo-Num.parse.3
+++ b/man/man3/tomo-Num.parse.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.parse 3 2025-04-19T14:52:07.136065 "Tomo man-pages"
+.TH Num.parse 3 2025-04-21T14:44:34.260863 "Tomo man-pages"
.SH NAME
-Num.parse \- Converts a text representation of a number into a floating-point number.
-
+Num.parse \- convert text to number
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.parse\ :\ func(text:\ Text\ ->\ Num?)
.fi
-
.SH DESCRIPTION
Converts a text representation of a number into a floating-point number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.percent.3 b/man/man3/tomo-Num.percent.3
index 3b6d13bc..8643c327 100644
--- a/man/man3/tomo-Num.percent.3
+++ b/man/man3/tomo-Num.percent.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.percent 3 2025-04-19T14:52:07.136127 "Tomo man-pages"
+.TH Num.percent 3 2025-04-21T14:44:34.260898 "Tomo man-pages"
.SH NAME
-Num.percent \- Convert a number into a percentage text with a percent sign.
-
+Num.percent \- format as a percentage
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.percent\ :\ func(n:\ Num,\ precision:\ Int\ =\ 0\ ->\ Text)
.fi
-
.SH DESCRIPTION
Convert a number into a percentage text with a percent sign.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.rint.3 b/man/man3/tomo-Num.rint.3
index dc552d41..5c8fe013 100644
--- a/man/man3/tomo-Num.rint.3
+++ b/man/man3/tomo-Num.rint.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.rint 3 2025-04-19T14:52:07.136169 "Tomo man-pages"
+.TH Num.rint 3 2025-04-21T14:44:34.260949 "Tomo man-pages"
.SH NAME
-Num.rint \- Rounds a number to the nearest integer, with ties rounded to the nearest even integer.
-
+Num.rint \- round to nearest integer
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.rint\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Rounds a number to the nearest integer, with ties rounded to the nearest even integer.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.round.3 b/man/man3/tomo-Num.round.3
index 4c55806f..c4c29f53 100644
--- a/man/man3/tomo-Num.round.3
+++ b/man/man3/tomo-Num.round.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.round 3 2025-04-19T14:52:07.136211 "Tomo man-pages"
+.TH Num.round 3 2025-04-21T14:44:34.260982 "Tomo man-pages"
.SH NAME
-Num.round \- Rounds a number to the nearest whole number integer.
-
+Num.round \- round to nearest integer
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.round\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Rounds a number to the nearest whole number integer.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.scientific.3 b/man/man3/tomo-Num.scientific.3
index 1239913e..d407e084 100644
--- a/man/man3/tomo-Num.scientific.3
+++ b/man/man3/tomo-Num.scientific.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.scientific 3 2025-04-19T14:52:07.136250 "Tomo man-pages"
+.TH Num.scientific 3 2025-04-21T14:44:34.261014 "Tomo man-pages"
.SH NAME
-Num.scientific \- Formats a number in scientific notation with a specified precision.
-
+Num.scientific \- format in scientific notation
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.scientific\ :\ func(n:\ Num,\ precision:\ Int\ =\ 0\ ->\ Text)
.fi
-
.SH DESCRIPTION
Formats a number in scientific notation with a specified precision.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.significand.3 b/man/man3/tomo-Num.significand.3
index 06ce78d0..b08991e4 100644
--- a/man/man3/tomo-Num.significand.3
+++ b/man/man3/tomo-Num.significand.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.significand 3 2025-04-19T14:52:07.136287 "Tomo man-pages"
+.TH Num.significand 3 2025-04-21T14:44:34.261046 "Tomo man-pages"
.SH NAME
-Num.significand \- Extracts the significand (or mantissa) of a number.
-
+Num.significand \- get mantissa
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.significand\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Extracts the significand (or mantissa) of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.sin.3 b/man/man3/tomo-Num.sin.3
index 993ba9ec..ec069a04 100644
--- a/man/man3/tomo-Num.sin.3
+++ b/man/man3/tomo-Num.sin.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.sin 3 2025-04-19T14:52:07.136351 "Tomo man-pages"
+.TH Num.sin 3 2025-04-21T14:44:34.261093 "Tomo man-pages"
.SH NAME
-Num.sin \- Computes the sine of a number (angle in radians).
-
+Num.sin \- sine
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.sin\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the sine of a number (angle in radians).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.sinh.3 b/man/man3/tomo-Num.sinh.3
index 2f82f3ef..b2fc7ff3 100644
--- a/man/man3/tomo-Num.sinh.3
+++ b/man/man3/tomo-Num.sinh.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.sinh 3 2025-04-19T14:52:07.136392 "Tomo man-pages"
+.TH Num.sinh 3 2025-04-21T14:44:34.261128 "Tomo man-pages"
.SH NAME
-Num.sinh \- Computes the hyperbolic sine of a number.
-
+Num.sinh \- hyperbolic sine
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.sinh\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the hyperbolic sine of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.sqrt.3 b/man/man3/tomo-Num.sqrt.3
index 7d003b0f..49074c5e 100644
--- a/man/man3/tomo-Num.sqrt.3
+++ b/man/man3/tomo-Num.sqrt.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.sqrt 3 2025-04-19T14:52:07.136430 "Tomo man-pages"
+.TH Num.sqrt 3 2025-04-21T14:44:34.261162 "Tomo man-pages"
.SH NAME
-Num.sqrt \- Computes the square root of a number.
-
+Num.sqrt \- square root
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.sqrt\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the square root of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.tan.3 b/man/man3/tomo-Num.tan.3
index 1e9d5bf0..7f7bc355 100644
--- a/man/man3/tomo-Num.tan.3
+++ b/man/man3/tomo-Num.tan.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.tan 3 2025-04-19T14:52:07.136467 "Tomo man-pages"
+.TH Num.tan 3 2025-04-21T14:44:34.261195 "Tomo man-pages"
.SH NAME
-Num.tan \- Computes the tangent of a number (angle in radians).
-
+Num.tan \- tangent
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.tan\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the tangent of a number (angle in radians).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.tanh.3 b/man/man3/tomo-Num.tanh.3
index da664498..6d56e459 100644
--- a/man/man3/tomo-Num.tanh.3
+++ b/man/man3/tomo-Num.tanh.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.tanh 3 2025-04-19T14:52:07.136526 "Tomo man-pages"
+.TH Num.tanh 3 2025-04-21T14:44:34.261228 "Tomo man-pages"
.SH NAME
-Num.tanh \- Computes the hyperbolic tangent of a number.
-
+Num.tanh \- hyperbolic tangent
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.tanh\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the hyperbolic tangent of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.tgamma.3 b/man/man3/tomo-Num.tgamma.3
index ef31ad5d..4a114850 100644
--- a/man/man3/tomo-Num.tgamma.3
+++ b/man/man3/tomo-Num.tgamma.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.tgamma 3 2025-04-19T14:52:07.136566 "Tomo man-pages"
+.TH Num.tgamma 3 2025-04-21T14:44:34.261261 "Tomo man-pages"
.SH NAME
-Num.tgamma \- Computes the gamma function of a number.
-
+Num.tgamma \- true gamma function
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.tgamma\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the gamma function of a number.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.trunc.3 b/man/man3/tomo-Num.trunc.3
index ab23ae2a..156cf21b 100644
--- a/man/man3/tomo-Num.trunc.3
+++ b/man/man3/tomo-Num.trunc.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.trunc 3 2025-04-19T14:52:07.136603 "Tomo man-pages"
+.TH Num.trunc 3 2025-04-21T14:44:34.261318 "Tomo man-pages"
.SH NAME
-Num.trunc \- Truncates a number to the nearest integer towards zero.
-
+Num.trunc \- truncate a number
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.trunc\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Truncates a number to the nearest integer towards zero.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.y0.3 b/man/man3/tomo-Num.y0.3
index 72d0fe9b..60997e32 100644
--- a/man/man3/tomo-Num.y0.3
+++ b/man/man3/tomo-Num.y0.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.y0 3 2025-04-19T14:52:07.136639 "Tomo man-pages"
+.TH Num.y0 3 2025-04-21T14:44:34.261358 "Tomo man-pages"
.SH NAME
-Num.y0 \- Computes the Bessel function of the second kind of order 0.
-
+Num.y0 \- Bessel function
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.y0\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the Bessel function of the second kind of order 0.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Num.y1.3 b/man/man3/tomo-Num.y1.3
index 69c50088..f349cbac 100644
--- a/man/man3/tomo-Num.y1.3
+++ b/man/man3/tomo-Num.y1.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Num.y1 3 2025-04-19T14:52:07.136676 "Tomo man-pages"
+.TH Num.y1 3 2025-04-21T14:44:34.261398 "Tomo man-pages"
.SH NAME
-Num.y1 \- Computes the Bessel function of the second kind of order 1.
-
+Num.y1 \- Bessel function
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Num.y1\ :\ func(x:\ Num\ ->\ Num)
.fi
-
.SH DESCRIPTION
Computes the Bessel function of the second kind of order 1.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.accessed.3 b/man/man3/tomo-Path.accessed.3
index 6a5ac6c7..35dc822e 100644
--- a/man/man3/tomo-Path.accessed.3
+++ b/man/man3/tomo-Path.accessed.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.accessed 3 2025-04-19T14:52:07.137170 "Tomo man-pages"
+.TH Path.accessed 3 2025-04-21T14:44:34.261899 "Tomo man-pages"
.SH NAME
-Path.accessed \- Gets the file access time of a file.
-
+Path.accessed \- access time
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.accessed\ :\ func(path:\ Path,\ follow_symlinks:\ Bool\ =\ yes\ ->\ Int64?)
.fi
-
.SH DESCRIPTION
Gets the file access time of a file.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.append.3 b/man/man3/tomo-Path.append.3
index 1eddf1d0..ce386857 100644
--- a/man/man3/tomo-Path.append.3
+++ b/man/man3/tomo-Path.append.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.append 3 2025-04-19T14:52:07.137229 "Tomo man-pages"
+.TH Path.append 3 2025-04-21T14:44:34.261936 "Tomo man-pages"
.SH NAME
-Path.append \- Appends the given text to the file at the specified path, creating the file if it doesn't already exist. Failure to write will result in a runtime error.
-
+Path.append \- append to a file
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.append\ :\ func(path:\ Path,\ text:\ Text,\ permissions:\ Int32\ =\ Int32(0o644)\ ->\ Void)
.fi
-
.SH DESCRIPTION
Appends the given text to the file at the specified path, creating the file if it doesn't already exist. Failure to write will result in a runtime error.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.append_bytes.3 b/man/man3/tomo-Path.append_bytes.3
index b0e3fe61..de5785cb 100644
--- a/man/man3/tomo-Path.append_bytes.3
+++ b/man/man3/tomo-Path.append_bytes.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.append_bytes 3 2025-04-19T14:52:07.137277 "Tomo man-pages"
+.TH Path.append_bytes 3 2025-04-21T14:44:34.261974 "Tomo man-pages"
.SH NAME
-Path.append_bytes \- Appends the given bytes to the file at the specified path, creating the file if it doesn't already exist. Failure to write will result in a runtime error.
-
+Path.append_bytes \- append bytes to a file
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.append_bytes\ :\ func(path:\ Path,\ bytes:\ [Byte],\ permissions:\ Int32\ =\ Int32(0o644)\ ->\ Void)
.fi
-
.SH DESCRIPTION
Appends the given bytes to the file at the specified path, creating the file if it doesn't already exist. Failure to write will result in a runtime error.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.base_name.3 b/man/man3/tomo-Path.base_name.3
index a0a7ec87..c0022f06 100644
--- a/man/man3/tomo-Path.base_name.3
+++ b/man/man3/tomo-Path.base_name.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.base_name 3 2025-04-19T14:52:07.137319 "Tomo man-pages"
+.TH Path.base_name 3 2025-04-21T14:44:34.262009 "Tomo man-pages"
.SH NAME
-Path.base_name \- Returns the base name of the file or directory at the specified path.
-
+Path.base_name \- base name of a file
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.base_name\ :\ func(path:\ Path\ ->\ Text)
.fi
-
.SH DESCRIPTION
Returns the base name of the file or directory at the specified path.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.by_line.3 b/man/man3/tomo-Path.by_line.3
index 8e39246f..c6de5179 100644
--- a/man/man3/tomo-Path.by_line.3
+++ b/man/man3/tomo-Path.by_line.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.by_line 3 2025-04-19T14:52:07.137355 "Tomo man-pages"
+.TH Path.by_line 3 2025-04-21T14:44:34.262041 "Tomo man-pages"
.SH NAME
-Path.by_line \- Returns an iterator that can be used to iterate over a file one line at a time, or returns a null value if the file could not be opened.
-
+Path.by_line \- iterate by line
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.by_line\ :\ func(path:\ Path\ ->\ func(->Text?)?)
.fi
-
.SH DESCRIPTION
Returns an iterator that can be used to iterate over a file one line at a time, or returns a null value if the file could not be opened.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.can_execute.3 b/man/man3/tomo-Path.can_execute.3
index d195739b..62792fd4 100644
--- a/man/man3/tomo-Path.can_execute.3
+++ b/man/man3/tomo-Path.can_execute.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.can_execute 3 2025-04-19T14:52:07.137395 "Tomo man-pages"
+.TH Path.can_execute 3 2025-04-21T14:44:34.262076 "Tomo man-pages"
.SH NAME
-Path.can_execute \- Returns whether or not a file can be executed by the current user/group.
-
+Path.can_execute \- check execute permissions
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.can_execute\ :\ func(path:\ Path\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Returns whether or not a file can be executed by the current user/group.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.can_read.3 b/man/man3/tomo-Path.can_read.3
index de59f856..56a2715b 100644
--- a/man/man3/tomo-Path.can_read.3
+++ b/man/man3/tomo-Path.can_read.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.can_read 3 2025-04-19T14:52:07.137436 "Tomo man-pages"
+.TH Path.can_read 3 2025-04-21T14:44:34.262109 "Tomo man-pages"
.SH NAME
-Path.can_read \- Returns whether or not a file can be read by the current user/group.
-
+Path.can_read \- check read permissions
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.can_read\ :\ func(path:\ Path\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Returns whether or not a file can be read by the current user/group.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.can_write.3 b/man/man3/tomo-Path.can_write.3
index c187d144..25b5318d 100644
--- a/man/man3/tomo-Path.can_write.3
+++ b/man/man3/tomo-Path.can_write.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.can_write 3 2025-04-19T14:52:07.137477 "Tomo man-pages"
+.TH Path.can_write 3 2025-04-21T14:44:34.262141 "Tomo man-pages"
.SH NAME
-Path.can_write \- Returns whether or not a file can be written by the current user/group.
-
+Path.can_write \- check write permissions
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.can_write\ :\ func(path:\ Path\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Returns whether or not a file can be written by the current user/group.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.changed.3 b/man/man3/tomo-Path.changed.3
index 9392a370..4735b341 100644
--- a/man/man3/tomo-Path.changed.3
+++ b/man/man3/tomo-Path.changed.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.changed 3 2025-04-19T14:52:07.137514 "Tomo man-pages"
+.TH Path.changed 3 2025-04-21T14:44:34.262187 "Tomo man-pages"
.SH NAME
-Path.changed \- Gets the file change time of a file.
-
+Path.changed \- get the last changed time
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.changed\ :\ func(path:\ Path,\ follow_symlinks:\ Bool\ =\ yes\ ->\ Int64?)
.fi
-
.SH DESCRIPTION
Gets the file change time of a file.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.child.3 b/man/man3/tomo-Path.child.3
index 60853771..54ef7021 100644
--- a/man/man3/tomo-Path.child.3
+++ b/man/man3/tomo-Path.child.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.child 3 2025-04-19T14:52:07.137557 "Tomo man-pages"
+.TH Path.child 3 2025-04-21T14:44:34.262224 "Tomo man-pages"
.SH NAME
-Path.child \- Return a path that is a child of another path.
-
+Path.child \- append a child to a path
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.child\ :\ func(path:\ Path,\ child:\ Text\ ->\ [Path])
.fi
-
.SH DESCRIPTION
Return a path that is a child of another path.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.children.3 b/man/man3/tomo-Path.children.3
index 3380fee7..44365b06 100644
--- a/man/man3/tomo-Path.children.3
+++ b/man/man3/tomo-Path.children.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.children 3 2025-04-19T14:52:07.137592 "Tomo man-pages"
+.TH Path.children 3 2025-04-21T14:44:34.262258 "Tomo man-pages"
.SH NAME
-Path.children \- Returns a list of children (files and directories) within the directory at the specified path. Optionally includes hidden files.
-
+Path.children \- get children of a directory
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.children\ :\ func(path:\ Path,\ include_hidden\ =\ no\ ->\ [Path])
.fi
-
.SH DESCRIPTION
Returns a list of children (files and directories) within the directory at the specified path. Optionally includes hidden files.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.create_directory.3 b/man/man3/tomo-Path.create_directory.3
index 8992d78b..f1fb213c 100644
--- a/man/man3/tomo-Path.create_directory.3
+++ b/man/man3/tomo-Path.create_directory.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.create_directory 3 2025-04-19T14:52:07.137631 "Tomo man-pages"
+.TH Path.create_directory 3 2025-04-21T14:44:34.262292 "Tomo man-pages"
.SH NAME
-Path.create_directory \- Creates a new directory at the specified path with the given permissions. If any of the parent directories do not exist, they will be created as needed.
-
+Path.create_directory \- make a directory
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.create_directory\ :\ func(path:\ Path,\ permissions\ =\ Int32(0o755)\ ->\ Void)
.fi
-
.SH DESCRIPTION
Creates a new directory at the specified path with the given permissions. If any of the parent directories do not exist, they will be created as needed.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.current_dir.3 b/man/man3/tomo-Path.current_dir.3
index 0ca3ec22..a360e55f 100644
--- a/man/man3/tomo-Path.current_dir.3
+++ b/man/man3/tomo-Path.current_dir.3
@@ -2,20 +2,19 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.current_dir 3 2025-04-19T14:52:07.137666 "Tomo man-pages"
+.TH Path.current_dir 3 2025-04-21T14:44:34.262325 "Tomo man-pages"
.SH NAME
-Path.current_dir \- Creates a new directory at the specified path with the given permissions. If any of the parent directories do not exist, they will be created as needed.
-
+Path.current_dir \- get current directory
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.current_dir\ :\ func(->\ Path)
.fi
-
.SH DESCRIPTION
Creates a new directory at the specified path with the given permissions. If any of the parent directories do not exist, they will be created as needed.
+
.SH RETURN
The absolute path of the current directory.
diff --git a/man/man3/tomo-Path.exists.3 b/man/man3/tomo-Path.exists.3
index d6bb9553..56297e48 100644
--- a/man/man3/tomo-Path.exists.3
+++ b/man/man3/tomo-Path.exists.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.exists 3 2025-04-19T14:52:07.137705 "Tomo man-pages"
+.TH Path.exists 3 2025-04-21T14:44:34.262356 "Tomo man-pages"
.SH NAME
-Path.exists \- Checks if a file or directory exists at the specified path.
-
+Path.exists \- check if a path exists
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.exists\ :\ func(path:\ Path\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks if a file or directory exists at the specified path.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.expand_home.3 b/man/man3/tomo-Path.expand_home.3
index 20f7c61e..7960350b 100644
--- a/man/man3/tomo-Path.expand_home.3
+++ b/man/man3/tomo-Path.expand_home.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.expand_home 3 2025-04-19T14:52:07.137760 "Tomo man-pages"
+.TH Path.expand_home 3 2025-04-21T14:44:34.262389 "Tomo man-pages"
.SH NAME
-Path.expand_home \- For home-based paths (those starting with `~`), expand the path to replace the tilde with and absolute path to the user's `$HOME` directory.
-
+Path.expand_home \- expand ~ to $HOME
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.expand_home\ :\ func(path:\ Path\ ->\ Path)
.fi
-
.SH DESCRIPTION
For home-based paths (those starting with `~`), expand the path to replace the tilde with and absolute path to the user's `$HOME` directory.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.extension.3 b/man/man3/tomo-Path.extension.3
index 96963134..644a6386 100644
--- a/man/man3/tomo-Path.extension.3
+++ b/man/man3/tomo-Path.extension.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.extension 3 2025-04-19T14:52:07.137803 "Tomo man-pages"
+.TH Path.extension 3 2025-04-21T14:44:34.262449 "Tomo man-pages"
.SH NAME
-Path.extension \- Returns the file extension of the file at the specified path. Optionally returns the full extension.
-
+Path.extension \- get file extension
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.extension\ :\ func(path:\ Path,\ full:\ Bool\ =\ yes\ ->\ Text)
.fi
-
.SH DESCRIPTION
Returns the file extension of the file at the specified path. Optionally returns the full extension.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.files.3 b/man/man3/tomo-Path.files.3
index 9fa044d2..cb20790c 100644
--- a/man/man3/tomo-Path.files.3
+++ b/man/man3/tomo-Path.files.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.files 3 2025-04-19T14:52:07.137843 "Tomo man-pages"
+.TH Path.files 3 2025-04-21T14:44:34.262492 "Tomo man-pages"
.SH NAME
-Path.files \- Returns a list of files within the directory at the specified path. Optionally includes hidden files.
-
+Path.files \- list files in a directory
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.files\ :\ func(path:\ Path,\ include_hidden:\ Bool\ =\ no\ ->\ [Path])
.fi
-
.SH DESCRIPTION
Returns a list of files within the directory at the specified path. Optionally includes hidden files.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.from_components.3 b/man/man3/tomo-Path.from_components.3
index 494e1189..d7dec080 100644
--- a/man/man3/tomo-Path.from_components.3
+++ b/man/man3/tomo-Path.from_components.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.from_components 3 2025-04-19T14:52:07.137888 "Tomo man-pages"
+.TH Path.from_components 3 2025-04-21T14:44:34.262540 "Tomo man-pages"
.SH NAME
-Path.from_components \- Returns a path built from a list of path components.
-
+Path.from_components \- build a path from components
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.from_components\ :\ func(components:\ [Text]\ ->\ Path)
.fi
-
.SH DESCRIPTION
Returns a path built from a list of path components.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.glob.3 b/man/man3/tomo-Path.glob.3
index 9be429cc..cb373635 100644
--- a/man/man3/tomo-Path.glob.3
+++ b/man/man3/tomo-Path.glob.3
@@ -2,23 +2,15 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.glob 3 2025-04-19T14:52:07.137927 "Tomo man-pages"
+.TH Path.glob 3 2025-04-21T14:44:34.262574 "Tomo man-pages"
.SH NAME
-Path.glob \- Perform a globbing operation and return a list of matching paths. Some glob specific details:
-- The paths "." and ".." are *not* included in any globbing results.
-- Files or directories that begin with "." will not match `*`, but will match `.*`.
-- Globs do support `{a,b}` syntax for matching files that match any of several
- choices of patterns.
-
-- The shell-style syntax `**` for matching subdirectories is not supported.
-
+Path.glob \- perform file globbing
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.glob\ :\ func(path:\ Path\ ->\ [Path])
.fi
-
.SH DESCRIPTION
Perform a globbing operation and return a list of matching paths. Some glob specific details:
- The paths "." and ".." are *not* included in any globbing results.
@@ -29,6 +21,8 @@ Perform a globbing operation and return a list of matching paths. Some glob spec
- The shell-style syntax `**` for matching subdirectories is not supported.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.group.3 b/man/man3/tomo-Path.group.3
index 2b5a4ed3..44653dd3 100644
--- a/man/man3/tomo-Path.group.3
+++ b/man/man3/tomo-Path.group.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.group 3 2025-04-19T14:52:07.137969 "Tomo man-pages"
+.TH Path.group 3 2025-04-21T14:44:34.262623 "Tomo man-pages"
.SH NAME
-Path.group \- Get the owning group of a file or directory.
-
+Path.group \- get the owning group
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.group\ :\ func(path:\ Path,\ follow_symlinks:\ Bool\ =\ yes\ ->\ Text?)
.fi
-
.SH DESCRIPTION
Get the owning group of a file or directory.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.is_directory.3 b/man/man3/tomo-Path.is_directory.3
index ed3cc3a9..19c1d5c0 100644
--- a/man/man3/tomo-Path.is_directory.3
+++ b/man/man3/tomo-Path.is_directory.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.is_directory 3 2025-04-19T14:52:07.138006 "Tomo man-pages"
+.TH Path.is_directory 3 2025-04-21T14:44:34.262657 "Tomo man-pages"
.SH NAME
-Path.is_directory \- Checks if the path represents a directory. Optionally follows symbolic links.
-
+Path.is_directory \- check if a path is a directory
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.is_directory\ :\ func(path:\ Path,\ follow_symlinks\ =\ yes\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks if the path represents a directory. Optionally follows symbolic links.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.is_file.3 b/man/man3/tomo-Path.is_file.3
index 48c64028..3171e8dc 100644
--- a/man/man3/tomo-Path.is_file.3
+++ b/man/man3/tomo-Path.is_file.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.is_file 3 2025-04-19T14:52:07.138046 "Tomo man-pages"
+.TH Path.is_file 3 2025-04-21T14:44:34.262693 "Tomo man-pages"
.SH NAME
-Path.is_file \- Checks if the path represents a file. Optionally follows symbolic links.
-
+Path.is_file \- check if a path is a file
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.is_file\ :\ func(path:\ Path,\ follow_symlinks\ =\ yes\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks if the path represents a file. Optionally follows symbolic links.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.is_socket.3 b/man/man3/tomo-Path.is_socket.3
index 3c517755..dd227969 100644
--- a/man/man3/tomo-Path.is_socket.3
+++ b/man/man3/tomo-Path.is_socket.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.is_socket 3 2025-04-19T14:52:07.138082 "Tomo man-pages"
+.TH Path.is_socket 3 2025-04-21T14:44:34.262728 "Tomo man-pages"
.SH NAME
-Path.is_socket \- Checks if the path represents a socket. Optionally follows symbolic links.
-
+Path.is_socket \- check if a path is a socket
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.is_socket\ :\ func(path:\ Path,\ follow_symlinks\ =\ yes\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks if the path represents a socket. Optionally follows symbolic links.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.is_symlink.3 b/man/man3/tomo-Path.is_symlink.3
index 78275401..5d101524 100644
--- a/man/man3/tomo-Path.is_symlink.3
+++ b/man/man3/tomo-Path.is_symlink.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.is_symlink 3 2025-04-19T14:52:07.138117 "Tomo man-pages"
+.TH Path.is_symlink 3 2025-04-21T14:44:34.262781 "Tomo man-pages"
.SH NAME
-Path.is_symlink \- Checks if the path represents a symbolic link.
-
+Path.is_symlink \- check if a path is a symbolic link
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.is_symlink\ :\ func(path:\ Path\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks if the path represents a symbolic link.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.modified.3 b/man/man3/tomo-Path.modified.3
index 8287a53a..9ed43d07 100644
--- a/man/man3/tomo-Path.modified.3
+++ b/man/man3/tomo-Path.modified.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.modified 3 2025-04-19T14:52:07.138152 "Tomo man-pages"
+.TH Path.modified 3 2025-04-21T14:44:34.262813 "Tomo man-pages"
.SH NAME
-Path.modified \- Gets the file modification time of a file.
-
+Path.modified \- get file modification time
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.modified\ :\ func(path:\ Path,\ follow_symlinks:\ Bool\ =\ yes\ ->\ Int64?)
.fi
-
.SH DESCRIPTION
Gets the file modification time of a file.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.owner.3 b/man/man3/tomo-Path.owner.3
index 22e83b2d..99b2e388 100644
--- a/man/man3/tomo-Path.owner.3
+++ b/man/man3/tomo-Path.owner.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.owner 3 2025-04-19T14:52:07.138188 "Tomo man-pages"
+.TH Path.owner 3 2025-04-21T14:44:34.262846 "Tomo man-pages"
.SH NAME
-Path.owner \- Get the owning user of a file or directory.
-
+Path.owner \- get file owner
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.owner\ :\ func(path:\ Path,\ follow_symlinks:\ Bool\ =\ yes\ ->\ Text?)
.fi
-
.SH DESCRIPTION
Get the owning user of a file or directory.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.parent.3 b/man/man3/tomo-Path.parent.3
index d0700154..f332a71d 100644
--- a/man/man3/tomo-Path.parent.3
+++ b/man/man3/tomo-Path.parent.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.parent 3 2025-04-19T14:52:07.138225 "Tomo man-pages"
+.TH Path.parent 3 2025-04-21T14:44:34.262879 "Tomo man-pages"
.SH NAME
-Path.parent \- Returns the parent directory of the file or directory at the specified path.
-
+Path.parent \- get parent directory
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.parent\ :\ func(path:\ Path\ ->\ Path)
.fi
-
.SH DESCRIPTION
Returns the parent directory of the file or directory at the specified path.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.read.3 b/man/man3/tomo-Path.read.3
index 3be4ed1b..171d6d81 100644
--- a/man/man3/tomo-Path.read.3
+++ b/man/man3/tomo-Path.read.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.read 3 2025-04-19T14:52:07.138259 "Tomo man-pages"
+.TH Path.read 3 2025-04-21T14:44:34.262910 "Tomo man-pages"
.SH NAME
-Path.read \- Reads the contents of the file at the specified path or a null value if the file could not be read.
-
+Path.read \- read file contents
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.read\ :\ func(path:\ Path\ ->\ Text?)
.fi
-
.SH DESCRIPTION
Reads the contents of the file at the specified path or a null value if the file could not be read.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.read_bytes.3 b/man/man3/tomo-Path.read_bytes.3
index 10dbfc5b..c49bd8d2 100644
--- a/man/man3/tomo-Path.read_bytes.3
+++ b/man/man3/tomo-Path.read_bytes.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.read_bytes 3 2025-04-19T14:52:07.138313 "Tomo man-pages"
+.TH Path.read_bytes 3 2025-04-21T14:44:34.262957 "Tomo man-pages"
.SH NAME
-Path.read_bytes \- Reads the contents of the file at the specified path or a null value if the file could not be read.
-
+Path.read_bytes \- read file contents as bytes
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.read_bytes\ :\ func(path:\ Path,\ limit:\ Int?\ =\ none\ ->\ [Byte]?)
.fi
-
.SH DESCRIPTION
Reads the contents of the file at the specified path or a null value if the file could not be read.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.relative_to.3 b/man/man3/tomo-Path.relative_to.3
index 21d758c0..ff343395 100644
--- a/man/man3/tomo-Path.relative_to.3
+++ b/man/man3/tomo-Path.relative_to.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.relative_to 3 2025-04-19T14:52:07.138354 "Tomo man-pages"
+.TH Path.relative_to 3 2025-04-21T14:44:34.262994 "Tomo man-pages"
.SH NAME
-Path.relative_to \- Returns the path relative to a given base path. By default, the base path is the current directory.
-
+Path.relative_to \- apply a relative path to another
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.relative_to\ :\ func(path:\ Path,\ relative_to\ =\ (./)\ ->\ Path)
.fi
-
.SH DESCRIPTION
Returns the path relative to a given base path. By default, the base path is the current directory.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.remove.3 b/man/man3/tomo-Path.remove.3
index 88aab028..f9ef51ee 100644
--- a/man/man3/tomo-Path.remove.3
+++ b/man/man3/tomo-Path.remove.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.remove 3 2025-04-19T14:52:07.138390 "Tomo man-pages"
+.TH Path.remove 3 2025-04-21T14:44:34.263029 "Tomo man-pages"
.SH NAME
-Path.remove \- Removes the file or directory at the specified path. A runtime error is raised if something goes wrong.
-
+Path.remove \- remove a file or directory
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.remove\ :\ func(path:\ Path,\ ignore_missing\ =\ no\ ->\ Void)
.fi
-
.SH DESCRIPTION
Removes the file or directory at the specified path. A runtime error is raised if something goes wrong.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.resolved.3 b/man/man3/tomo-Path.resolved.3
index 71ad5881..6ef94de2 100644
--- a/man/man3/tomo-Path.resolved.3
+++ b/man/man3/tomo-Path.resolved.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.resolved 3 2025-04-19T14:52:07.138427 "Tomo man-pages"
+.TH Path.resolved 3 2025-04-21T14:44:34.263062 "Tomo man-pages"
.SH NAME
-Path.resolved \- Resolves the absolute path of the given path relative to a base path. By default, the base path is the current directory.
-
+Path.resolved \- resolve a path
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.resolved\ :\ func(path:\ Path,\ relative_to\ =\ (./)\ ->\ Path)
.fi
-
.SH DESCRIPTION
Resolves the absolute path of the given path relative to a base path. By default, the base path is the current directory.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.set_owner.3 b/man/man3/tomo-Path.set_owner.3
index 9eef2ae1..0004f81b 100644
--- a/man/man3/tomo-Path.set_owner.3
+++ b/man/man3/tomo-Path.set_owner.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.set_owner 3 2025-04-19T14:52:07.138465 "Tomo man-pages"
+.TH Path.set_owner 3 2025-04-21T14:44:34.263096 "Tomo man-pages"
.SH NAME
-Path.set_owner \- Set the owning user and/or group for a path.
-
+Path.set_owner \- set the owner
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.set_owner\ :\ func(path:\ Path,\ owner:\ Text?\ =\ none,\ group:\ Text?\ =\ none,\ follow_symlinks:\ Bool\ =\ yes\ ->\ Void)
.fi
-
.SH DESCRIPTION
Set the owning user and/or group for a path.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.subdirectories.3 b/man/man3/tomo-Path.subdirectories.3
index 1c8bd997..3bb39ef9 100644
--- a/man/man3/tomo-Path.subdirectories.3
+++ b/man/man3/tomo-Path.subdirectories.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.subdirectories 3 2025-04-19T14:52:07.138513 "Tomo man-pages"
+.TH Path.subdirectories 3 2025-04-21T14:44:34.263132 "Tomo man-pages"
.SH NAME
-Path.subdirectories \- Returns a list of subdirectories within the directory at the specified path. Optionally includes hidden subdirectories.
-
+Path.subdirectories \- get subdirectories
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.subdirectories\ :\ func(path:\ Path,\ include_hidden\ =\ no\ ->\ [Path])
.fi
-
.SH DESCRIPTION
Returns a list of subdirectories within the directory at the specified path. Optionally includes hidden subdirectories.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.unique_directory.3 b/man/man3/tomo-Path.unique_directory.3
index d56b75c5..5a172f8a 100644
--- a/man/man3/tomo-Path.unique_directory.3
+++ b/man/man3/tomo-Path.unique_directory.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.unique_directory 3 2025-04-19T14:52:07.138552 "Tomo man-pages"
+.TH Path.unique_directory 3 2025-04-21T14:44:34.263167 "Tomo man-pages"
.SH NAME
-Path.unique_directory \- Generates a unique directory path based on the given path. Useful for creating temporary directories.
-
+Path.unique_directory \- create a directory with a unique name
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.unique_directory\ :\ func(path:\ Path\ ->\ Path)
.fi
-
.SH DESCRIPTION
Generates a unique directory path based on the given path. Useful for creating temporary directories.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.write.3 b/man/man3/tomo-Path.write.3
index 8fe17b7d..321b1222 100644
--- a/man/man3/tomo-Path.write.3
+++ b/man/man3/tomo-Path.write.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.write 3 2025-04-19T14:52:07.138590 "Tomo man-pages"
+.TH Path.write 3 2025-04-21T14:44:34.263201 "Tomo man-pages"
.SH NAME
-Path.write \- Writes the given text to the file at the specified path, creating the file if it doesn't already exist. Sets the file permissions as specified. If the file writing cannot be successfully completed, a runtime error is raised.
-
+Path.write \- write to a file
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.write\ :\ func(path:\ Path,\ text:\ Text,\ permissions\ =\ Int32(0o644)\ ->\ Void)
.fi
-
.SH DESCRIPTION
Writes the given text to the file at the specified path, creating the file if it doesn't already exist. Sets the file permissions as specified. If the file writing cannot be successfully completed, a runtime error is raised.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.write_bytes.3 b/man/man3/tomo-Path.write_bytes.3
index 7a87e000..65e3203d 100644
--- a/man/man3/tomo-Path.write_bytes.3
+++ b/man/man3/tomo-Path.write_bytes.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.write_bytes 3 2025-04-19T14:52:07.138627 "Tomo man-pages"
+.TH Path.write_bytes 3 2025-04-21T14:44:34.263234 "Tomo man-pages"
.SH NAME
-Path.write_bytes \- Writes the given bytes to the file at the specified path, creating the file if it doesn't already exist. Sets the file permissions as specified. If the file writing cannot be successfully completed, a runtime error is raised.
-
+Path.write_bytes \- write bytes to a file
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.write_bytes\ :\ func(path:\ Path,\ bytes:\ [Byte],\ permissions\ =\ Int32(0o644)\ ->\ Void)
.fi
-
.SH DESCRIPTION
Writes the given bytes to the file at the specified path, creating the file if it doesn't already exist. Sets the file permissions as specified. If the file writing cannot be successfully completed, a runtime error is raised.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.write_unique.3 b/man/man3/tomo-Path.write_unique.3
index 1cee07b1..fe4d67b6 100644
--- a/man/man3/tomo-Path.write_unique.3
+++ b/man/man3/tomo-Path.write_unique.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.write_unique 3 2025-04-19T14:52:07.138666 "Tomo man-pages"
+.TH Path.write_unique 3 2025-04-21T14:44:34.263268 "Tomo man-pages"
.SH NAME
-Path.write_unique \- Writes the given text to a unique file path based on the specified path. The file is created if it doesn't exist. This is useful for creating temporary files.
-
+Path.write_unique \- write to a uniquely named file
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.write_unique\ :\ func(path:\ Path,\ text:\ Text\ ->\ Path)
.fi
-
.SH DESCRIPTION
Writes the given text to a unique file path based on the specified path. The file is created if it doesn't exist. This is useful for creating temporary files.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Path.write_unique_bytes.3 b/man/man3/tomo-Path.write_unique_bytes.3
index 3023b223..ae3cad3c 100644
--- a/man/man3/tomo-Path.write_unique_bytes.3
+++ b/man/man3/tomo-Path.write_unique_bytes.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Path.write_unique_bytes 3 2025-04-19T14:52:07.138703 "Tomo man-pages"
+.TH Path.write_unique_bytes 3 2025-04-21T14:44:34.263302 "Tomo man-pages"
.SH NAME
-Path.write_unique_bytes \- Writes the given bytes to a unique file path based on the specified path. The file is created if it doesn't exist. This is useful for creating temporary files.
-
+Path.write_unique_bytes \- write bytes to a uniquely named file
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.write_unique_bytes\ :\ func(path:\ Path,\ bytes:\ [Byte]\ ->\ Path)
.fi
-
.SH DESCRIPTION
Writes the given bytes to a unique file path based on the specified path. The file is created if it doesn't exist. This is useful for creating temporary files.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Set.add.3 b/man/man3/tomo-Set.add.3
index 9adebf32..c9841a97 100644
--- a/man/man3/tomo-Set.add.3
+++ b/man/man3/tomo-Set.add.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Set.add 3 2025-04-19T14:52:07.138743 "Tomo man-pages"
+.TH Set.add 3 2025-04-21T14:44:34.263338 "Tomo man-pages"
.SH NAME
-Set.add \- Adds an item to the set.
-
+Set.add \- add item to a set
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Set.add\ :\ func(set:\ |T|,\ item:\ T\ ->\ Void)
.fi
-
.SH DESCRIPTION
Adds an item to the set.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Set.add_all.3 b/man/man3/tomo-Set.add_all.3
index 84ebe5ba..4db72cce 100644
--- a/man/man3/tomo-Set.add_all.3
+++ b/man/man3/tomo-Set.add_all.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Set.add_all 3 2025-04-19T14:52:07.138779 "Tomo man-pages"
+.TH Set.add_all 3 2025-04-21T14:44:34.263371 "Tomo man-pages"
.SH NAME
-Set.add_all \- Adds multiple items to the set.
-
+Set.add_all \- add items to a set
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Set.add_all\ :\ func(set:\ @|T|,\ items:\ [T]\ ->\ Void)
.fi
-
.SH DESCRIPTION
Adds multiple items to the set.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Set.clear.3 b/man/man3/tomo-Set.clear.3
index 7a9f5b79..6787212f 100644
--- a/man/man3/tomo-Set.clear.3
+++ b/man/man3/tomo-Set.clear.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Set.clear 3 2025-04-19T14:52:07.138813 "Tomo man-pages"
+.TH Set.clear 3 2025-04-21T14:44:34.263403 "Tomo man-pages"
.SH NAME
-Set.clear \- Removes all items from the set.
-
+Set.clear \- clear a set
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Set.clear\ :\ func(set:\ @|T|\ ->\ Void)
.fi
-
.SH DESCRIPTION
Removes all items from the set.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Set.has.3 b/man/man3/tomo-Set.has.3
index 1cd45e93..3603aa79 100644
--- a/man/man3/tomo-Set.has.3
+++ b/man/man3/tomo-Set.has.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Set.has 3 2025-04-19T14:52:07.138868 "Tomo man-pages"
+.TH Set.has 3 2025-04-21T14:44:34.263448 "Tomo man-pages"
.SH NAME
-Set.has \- Checks if the set contains a specified item.
-
+Set.has \- check if a set has an item
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Set.has\ :\ func(set:\ |T|,\ item:\ T\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks if the set contains a specified item.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Set.is_subset_of.3 b/man/man3/tomo-Set.is_subset_of.3
index 7ce679d4..35b5c916 100644
--- a/man/man3/tomo-Set.is_subset_of.3
+++ b/man/man3/tomo-Set.is_subset_of.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Set.is_subset_of 3 2025-04-19T14:52:07.138911 "Tomo man-pages"
+.TH Set.is_subset_of 3 2025-04-21T14:44:34.263484 "Tomo man-pages"
.SH NAME
-Set.is_subset_of \- Checks if the set is a subset of another set.
-
+Set.is_subset_of \- check if a set is a subset
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Set.is_subset_of\ :\ func(set:\ |T|,\ other:\ |T|,\ strict:\ Bool\ =\ no\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks if the set is a subset of another set.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Set.is_superset_of.3 b/man/man3/tomo-Set.is_superset_of.3
index 73ce0f17..7d8309f0 100644
--- a/man/man3/tomo-Set.is_superset_of.3
+++ b/man/man3/tomo-Set.is_superset_of.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Set.is_superset_of 3 2025-04-19T14:52:07.138951 "Tomo man-pages"
+.TH Set.is_superset_of 3 2025-04-21T14:44:34.263519 "Tomo man-pages"
.SH NAME
-Set.is_superset_of \- Checks if the set is a superset of another set.
-
+Set.is_superset_of \- check if a set is a superset
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Set.is_superset_of\ :\ func(set:\ |T|,\ other:\ |T|,\ strict:\ Bool\ =\ no\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks if the set is a superset of another set.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Set.overlap.3 b/man/man3/tomo-Set.overlap.3
index 185e74c1..317df636 100644
--- a/man/man3/tomo-Set.overlap.3
+++ b/man/man3/tomo-Set.overlap.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Set.overlap 3 2025-04-19T14:52:07.138991 "Tomo man-pages"
+.TH Set.overlap 3 2025-04-21T14:44:34.263553 "Tomo man-pages"
.SH NAME
-Set.overlap \- Creates a new set with items that are in both the original set and another set.
-
+Set.overlap \- set intersection
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Set.overlap\ :\ func(set:\ |T|,\ other:\ |T|\ ->\ |T|)
.fi
-
.SH DESCRIPTION
Creates a new set with items that are in both the original set and another set.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Set.remove.3 b/man/man3/tomo-Set.remove.3
index d0ac8b8a..977f782f 100644
--- a/man/man3/tomo-Set.remove.3
+++ b/man/man3/tomo-Set.remove.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Set.remove 3 2025-04-19T14:52:07.139028 "Tomo man-pages"
+.TH Set.remove 3 2025-04-21T14:44:34.263586 "Tomo man-pages"
.SH NAME
-Set.remove \- Removes an item from the set.
-
+Set.remove \- remove an item from a set
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Set.remove\ :\ func(set:\ @|T|,\ item:\ T\ ->\ Void)
.fi
-
.SH DESCRIPTION
Removes an item from the set.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Set.remove_all.3 b/man/man3/tomo-Set.remove_all.3
index 4e65f5c4..e891e48a 100644
--- a/man/man3/tomo-Set.remove_all.3
+++ b/man/man3/tomo-Set.remove_all.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Set.remove_all 3 2025-04-19T14:52:07.139065 "Tomo man-pages"
+.TH Set.remove_all 3 2025-04-21T14:44:34.263618 "Tomo man-pages"
.SH NAME
-Set.remove_all \- Removes multiple items from the set.
-
+Set.remove_all \- remove items from a set
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Set.remove_all\ :\ func(set:\ @|T|,\ items:\ [T]\ ->\ Void)
.fi
-
.SH DESCRIPTION
Removes multiple items from the set.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Set.with.3 b/man/man3/tomo-Set.with.3
index 0fc3c4f1..714506e7 100644
--- a/man/man3/tomo-Set.with.3
+++ b/man/man3/tomo-Set.with.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Set.with 3 2025-04-19T14:52:07.139103 "Tomo man-pages"
+.TH Set.with 3 2025-04-21T14:44:34.263650 "Tomo man-pages"
.SH NAME
-Set.with \- Creates a new set that is the union of the original set and another set.
-
+Set.with \- set union
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Set.with\ :\ func(set:\ |T|,\ other:\ |T|\ ->\ |T|)
.fi
-
.SH DESCRIPTION
Creates a new set that is the union of the original set and another set.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Set.without.3 b/man/man3/tomo-Set.without.3
index d7c006e1..59e5f0be 100644
--- a/man/man3/tomo-Set.without.3
+++ b/man/man3/tomo-Set.without.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Set.without 3 2025-04-19T14:52:07.139141 "Tomo man-pages"
+.TH Set.without 3 2025-04-21T14:44:34.263693 "Tomo man-pages"
.SH NAME
-Set.without \- Creates a new set with items from the original set but without items from another set.
-
+Set.without \- set difference
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Set.without\ :\ func(set:\ |T|,\ other:\ |T|\ ->\ |T|)
.fi
-
.SH DESCRIPTION
Creates a new set with items from the original set but without items from another set.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Table.clear.3 b/man/man3/tomo-Table.clear.3
index 97c0fddc..f9ccb6f3 100644
--- a/man/man3/tomo-Table.clear.3
+++ b/man/man3/tomo-Table.clear.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Table.clear 3 2025-04-19T14:52:07.139181 "Tomo man-pages"
+.TH Table.clear 3 2025-04-21T14:44:34.263729 "Tomo man-pages"
.SH NAME
-Table.clear \- Removes all key-value pairs from the table.
-
+Table.clear \- clear a table
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Table.clear\ :\ func(t:\ &{K=V}\ ->\ Void)
.fi
-
.SH DESCRIPTION
Removes all key-value pairs from the table.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Table.get.3 b/man/man3/tomo-Table.get.3
index bcd7ebef..85796431 100644
--- a/man/man3/tomo-Table.get.3
+++ b/man/man3/tomo-Table.get.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Table.get 3 2025-04-19T14:52:07.139222 "Tomo man-pages"
+.TH Table.get 3 2025-04-21T14:44:34.263769 "Tomo man-pages"
.SH NAME
-Table.get \- Retrieves the value associated with a key, or returns `none` if the key is not present.
-
+Table.get \- get an item from a table
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Table.get\ :\ func(t:\ {K=V},\ key:\ K\ ->\ V?)
.fi
-
.SH DESCRIPTION
Retrieves the value associated with a key, or returns `none` if the key is not present.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Table.get_or_set.3 b/man/man3/tomo-Table.get_or_set.3
index 1bc5aaaa..4d2dcff7 100644
--- a/man/man3/tomo-Table.get_or_set.3
+++ b/man/man3/tomo-Table.get_or_set.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Table.get_or_set 3 2025-04-19T14:52:07.139265 "Tomo man-pages"
+.TH Table.get_or_set 3 2025-04-21T14:44:34.263808 "Tomo man-pages"
.SH NAME
-Table.get_or_set \- If the given key is in the table, return the associated value. Otherwise, insert the given default value into the table and return it.
-
+Table.get_or_set \- get an item or set a default if absent
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Table.get_or_set\ :\ func(t:\ &{K=V},\ key:\ K,\ default:\ V\ ->\ V?)
.fi
-
.SH DESCRIPTION
If the given key is in the table, return the associated value. Otherwise, insert the given default value into the table and return it.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Table.has.3 b/man/man3/tomo-Table.has.3
index 858e432d..eb338af8 100644
--- a/man/man3/tomo-Table.has.3
+++ b/man/man3/tomo-Table.has.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Table.has 3 2025-04-19T14:52:07.139306 "Tomo man-pages"
+.TH Table.has 3 2025-04-21T14:44:34.263846 "Tomo man-pages"
.SH NAME
-Table.has \- Checks if the table contains a specified key.
-
+Table.has \- check for a key
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Table.has\ :\ func(t:\ {K=V},\ key:\ K\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks if the table contains a specified key.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Table.remove.3 b/man/man3/tomo-Table.remove.3
index c1ade8c9..2cf998f5 100644
--- a/man/man3/tomo-Table.remove.3
+++ b/man/man3/tomo-Table.remove.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Table.remove 3 2025-04-19T14:52:07.139341 "Tomo man-pages"
+.TH Table.remove 3 2025-04-21T14:44:34.263882 "Tomo man-pages"
.SH NAME
-Table.remove \- Removes the key-value pair associated with a specified key.
-
+Table.remove \- remove a table entry
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Table.remove\ :\ func(t:\ {K=V},\ key:\ K\ ->\ Void)
.fi
-
.SH DESCRIPTION
Removes the key-value pair associated with a specified key.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Table.set.3 b/man/man3/tomo-Table.set.3
index fbaad52f..dcb9c0c8 100644
--- a/man/man3/tomo-Table.set.3
+++ b/man/man3/tomo-Table.set.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Table.set 3 2025-04-19T14:52:07.139375 "Tomo man-pages"
+.TH Table.set 3 2025-04-21T14:44:34.263917 "Tomo man-pages"
.SH NAME
-Table.set \- Sets or updates the value associated with a specified key.
-
+Table.set \- set a table entry
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Table.set\ :\ func(t:\ {K=V},\ key:\ K,\ value:\ V\ ->\ Void)
.fi
-
.SH DESCRIPTION
Sets or updates the value associated with a specified key.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.as_c_string.3 b/man/man3/tomo-Text.as_c_string.3
index 44c97713..e39efdb1 100644
--- a/man/man3/tomo-Text.as_c_string.3
+++ b/man/man3/tomo-Text.as_c_string.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.as_c_string 3 2025-04-19T14:52:07.139411 "Tomo man-pages"
+.TH Text.as_c_string 3 2025-04-21T14:44:34.263950 "Tomo man-pages"
.SH NAME
-Text.as_c_string \- Converts a `Text` value to a C-style string.
-
+Text.as_c_string \- convert to C-style string
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.as_c_string\ :\ func(text:\ Text\ ->\ CString)
.fi
-
.SH DESCRIPTION
Converts a `Text` value to a C-style string.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.at.3 b/man/man3/tomo-Text.at.3
index 1b565458..a3824677 100644
--- a/man/man3/tomo-Text.at.3
+++ b/man/man3/tomo-Text.at.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.at 3 2025-04-19T14:52:07.139465 "Tomo man-pages"
+.TH Text.at 3 2025-04-21T14:44:34.263995 "Tomo man-pages"
.SH NAME
-Text.at \- Get the graphical cluster at a given index. This is similar to `str[i]` with ASCII text, but has more correct behavior for unicode text.
-
+Text.at \- get a letter
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.at\ :\ func(text:\ Text,\ index:\ Int\ ->\ Text)
.fi
-
.SH DESCRIPTION
Get the graphical cluster at a given index. This is similar to `str[i]` with ASCII text, but has more correct behavior for unicode text.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.by_line.3 b/man/man3/tomo-Text.by_line.3
index 7930def0..4b4e510d 100644
--- a/man/man3/tomo-Text.by_line.3
+++ b/man/man3/tomo-Text.by_line.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.by_line 3 2025-04-19T14:52:07.139518 "Tomo man-pages"
+.TH Text.by_line 3 2025-04-21T14:44:34.264034 "Tomo man-pages"
.SH NAME
-Text.by_line \- Returns an iterator function that can be used to iterate over the lines in a text.
-
+Text.by_line \- iterate by line
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.by_line\ :\ func(text:\ Text\ ->\ func(->Text?))
.fi
-
.SH DESCRIPTION
Returns an iterator function that can be used to iterate over the lines in a text.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.by_split.3 b/man/man3/tomo-Text.by_split.3
index acd9c4ee..609f1228 100644
--- a/man/man3/tomo-Text.by_split.3
+++ b/man/man3/tomo-Text.by_split.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.by_split 3 2025-04-19T14:52:07.139557 "Tomo man-pages"
+.TH Text.by_split 3 2025-04-21T14:44:34.264070 "Tomo man-pages"
.SH NAME
-Text.by_split \- Returns an iterator function that can be used to iterate over text separated by a delimiter.
-
+Text.by_split \- iterate by a spliting text
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.by_split\ :\ func(text:\ Text,\ delimiter:\ Text\ =\ ""\ ->\ func(->Text?))
.fi
-
.SH DESCRIPTION
Returns an iterator function that can be used to iterate over text separated by a delimiter.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.by_split_any.3 b/man/man3/tomo-Text.by_split_any.3
index 5332e159..877e5f24 100644
--- a/man/man3/tomo-Text.by_split_any.3
+++ b/man/man3/tomo-Text.by_split_any.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.by_split_any 3 2025-04-19T14:52:07.139596 "Tomo man-pages"
+.TH Text.by_split_any 3 2025-04-21T14:44:34.264108 "Tomo man-pages"
.SH NAME
-Text.by_split_any \- Returns an iterator function that can be used to iterate over text separated by one or more characters (grapheme clusters) from a given text of delimiters.
-
+Text.by_split_any \- iterate by one of many splitting characters
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.by_split_any\ :\ func(text:\ Text,\ delimiters:\ Text\ =\ "\ $\[rs]t\[rs]r\[rs]n"\ ->\ func(->Text?))
.fi
-
.SH DESCRIPTION
Returns an iterator function that can be used to iterate over text separated by one or more characters (grapheme clusters) from a given text of delimiters.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.bytes.3 b/man/man3/tomo-Text.bytes.3
index 9488c4df..d1bf3b5e 100644
--- a/man/man3/tomo-Text.bytes.3
+++ b/man/man3/tomo-Text.bytes.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.bytes 3 2025-04-19T14:52:07.139637 "Tomo man-pages"
+.TH Text.bytes 3 2025-04-21T14:44:34.264144 "Tomo man-pages"
.SH NAME
-Text.bytes \- Converts a `Text` value to a list of bytes representing a UTF8 encoding of the text.
-
+Text.bytes \- get UTF8 bytes
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.bytes\ :\ func(text:\ Text\ ->\ [Byte])
.fi
-
.SH DESCRIPTION
Converts a `Text` value to a list of bytes representing a UTF8 encoding of the text.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.caseless_equals.3 b/man/man3/tomo-Text.caseless_equals.3
index 0b907ba0..fb702b74 100644
--- a/man/man3/tomo-Text.caseless_equals.3
+++ b/man/man3/tomo-Text.caseless_equals.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.caseless_equals 3 2025-04-19T14:52:07.139674 "Tomo man-pages"
+.TH Text.caseless_equals 3 2025-04-21T14:44:34.264178 "Tomo man-pages"
.SH NAME
-Text.caseless_equals \- Checks whether two texts are equal, ignoring the casing of the letters (i.e. case-insensitive comparison).
-
+Text.caseless_equals \- case-insensitive comparison
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.caseless_equals\ :\ func(a:\ Text,\ b:\ Text,\ language:\ Text\ =\ "C"\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks whether two texts are equal, ignoring the casing of the letters (i.e. case-insensitive comparison).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.codepoint_names.3 b/man/man3/tomo-Text.codepoint_names.3
index 3d9d277d..25370c4b 100644
--- a/man/man3/tomo-Text.codepoint_names.3
+++ b/man/man3/tomo-Text.codepoint_names.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.codepoint_names 3 2025-04-19T14:52:07.139717 "Tomo man-pages"
+.TH Text.codepoint_names 3 2025-04-21T14:44:34.264217 "Tomo man-pages"
.SH NAME
-Text.codepoint_names \- Returns a list of the names of each codepoint in the text.
-
+Text.codepoint_names \- get unicode codepoint names
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.codepoint_names\ :\ func(text:\ Text\ ->\ [Text])
.fi
-
.SH DESCRIPTION
Returns a list of the names of each codepoint in the text.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.ends_with.3 b/man/man3/tomo-Text.ends_with.3
index bea79b40..59e4e4af 100644
--- a/man/man3/tomo-Text.ends_with.3
+++ b/man/man3/tomo-Text.ends_with.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.ends_with 3 2025-04-19T14:52:07.139755 "Tomo man-pages"
+.TH Text.ends_with 3 2025-04-21T14:44:34.264252 "Tomo man-pages"
.SH NAME
-Text.ends_with \- Checks if the `Text` ends with a literal suffix text.
-
+Text.ends_with \- check suffix
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.ends_with\ :\ func(text:\ Text,\ suffix:\ Text\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks if the `Text` ends with a literal suffix text.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.from.3 b/man/man3/tomo-Text.from.3
index 884ff8ad..588b6a03 100644
--- a/man/man3/tomo-Text.from.3
+++ b/man/man3/tomo-Text.from.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.from 3 2025-04-19T14:52:07.139795 "Tomo man-pages"
+.TH Text.from 3 2025-04-21T14:44:34.264285 "Tomo man-pages"
.SH NAME
-Text.from \- Get a slice of the text, starting at the given position.
-
+Text.from \- slice from a starting index
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.from\ :\ func(text:\ Text,\ first:\ Int\ ->\ Text)
.fi
-
.SH DESCRIPTION
Get a slice of the text, starting at the given position.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.from_bytes.3 b/man/man3/tomo-Text.from_bytes.3
index 12910f41..f0c69aca 100644
--- a/man/man3/tomo-Text.from_bytes.3
+++ b/man/man3/tomo-Text.from_bytes.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.from_bytes 3 2025-04-19T14:52:07.139831 "Tomo man-pages"
+.TH Text.from_bytes 3 2025-04-21T14:44:34.264320 "Tomo man-pages"
.SH NAME
-Text.from_bytes \- Returns text that has been constructed from the given UTF8 bytes.
-
+Text.from_bytes \- convert UTF8 byte list to text
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.from_bytes\ :\ func(bytes:\ [Byte]\ ->\ [Text])
.fi
-
.SH DESCRIPTION
Returns text that has been constructed from the given UTF8 bytes.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.from_c_string.3 b/man/man3/tomo-Text.from_c_string.3
index 5c6afcd4..2ed128d0 100644
--- a/man/man3/tomo-Text.from_c_string.3
+++ b/man/man3/tomo-Text.from_c_string.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.from_c_string 3 2025-04-19T14:52:07.139868 "Tomo man-pages"
+.TH Text.from_c_string 3 2025-04-21T14:44:34.264353 "Tomo man-pages"
.SH NAME
-Text.from_c_string \- Converts a C-style string to a `Text` value.
-
+Text.from_c_string \- convert C-style string to text
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.from_c_string\ :\ func(str:\ CString\ ->\ Text)
.fi
-
.SH DESCRIPTION
Converts a C-style string to a `Text` value.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.from_codepoint_names.3 b/man/man3/tomo-Text.from_codepoint_names.3
index 8732239d..b64cdcaa 100644
--- a/man/man3/tomo-Text.from_codepoint_names.3
+++ b/man/man3/tomo-Text.from_codepoint_names.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.from_codepoint_names 3 2025-04-19T14:52:07.139903 "Tomo man-pages"
+.TH Text.from_codepoint_names 3 2025-04-21T14:44:34.264386 "Tomo man-pages"
.SH NAME
-Text.from_codepoint_names \- Returns text that has the given codepoint names (according to the Unicode specification) as its codepoints.
-
+Text.from_codepoint_names \- convert list of unicode codepoint names to text
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.from_codepoint_names\ :\ func(codepoint_names:\ [Text]\ ->\ [Text])
.fi
-
.SH DESCRIPTION
Returns text that has the given codepoint names (according to the Unicode specification) as its codepoints.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.from_codepoints.3 b/man/man3/tomo-Text.from_codepoints.3
index cfb78232..5d6f648d 100644
--- a/man/man3/tomo-Text.from_codepoints.3
+++ b/man/man3/tomo-Text.from_codepoints.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.from_codepoints 3 2025-04-19T14:52:07.139939 "Tomo man-pages"
+.TH Text.from_codepoints 3 2025-04-21T14:44:34.264420 "Tomo man-pages"
.SH NAME
-Text.from_codepoints \- Returns text that has been constructed from the given UTF32 codepoints.
-
+Text.from_codepoints \- convert UTF32 codepoints to text
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.from_codepoints\ :\ func(codepoints:\ [Int32]\ ->\ [Text])
.fi
-
.SH DESCRIPTION
Returns text that has been constructed from the given UTF32 codepoints.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.has.3 b/man/man3/tomo-Text.has.3
index ac6041dd..907a33a1 100644
--- a/man/man3/tomo-Text.has.3
+++ b/man/man3/tomo-Text.has.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.has 3 2025-04-19T14:52:07.139994 "Tomo man-pages"
+.TH Text.has 3 2025-04-21T14:44:34.264466 "Tomo man-pages"
.SH NAME
-Text.has \- Checks if the `Text` contains some target text.
-
+Text.has \- check for substring
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.has\ :\ func(text:\ Text,\ target:\ Text\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks if the `Text` contains some target text.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.join.3 b/man/man3/tomo-Text.join.3
index be4e698a..e8fed3c3 100644
--- a/man/man3/tomo-Text.join.3
+++ b/man/man3/tomo-Text.join.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.join 3 2025-04-19T14:52:07.140036 "Tomo man-pages"
+.TH Text.join 3 2025-04-21T14:44:34.264503 "Tomo man-pages"
.SH NAME
-Text.join \- Joins a list of text pieces with a specified glue.
-
+Text.join \- concatenate with separator
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.join\ :\ func(glue:\ Text,\ pieces:\ [Text]\ ->\ Text)
.fi
-
.SH DESCRIPTION
Joins a list of text pieces with a specified glue.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.left_pad.3 b/man/man3/tomo-Text.left_pad.3
index 8053fda8..7f6c2d82 100644
--- a/man/man3/tomo-Text.left_pad.3
+++ b/man/man3/tomo-Text.left_pad.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.left_pad 3 2025-04-19T14:52:07.140112 "Tomo man-pages"
+.TH Text.left_pad 3 2025-04-21T14:44:34.264573 "Tomo man-pages"
.SH NAME
-Text.left_pad \- Pad some text on the left side so it reaches a target width.
-
+Text.left_pad \- left-pad text
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.left_pad\ :\ func(text:\ Text,\ width:\ Int,\ pad:\ Text\ =\ "\ ",\ language:\ Text\ =\ "C"\ ->\ Text)
.fi
-
.SH DESCRIPTION
Pad some text on the left side so it reaches a target width.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.lines.3 b/man/man3/tomo-Text.lines.3
index 7d8991dd..9a787b6d 100644
--- a/man/man3/tomo-Text.lines.3
+++ b/man/man3/tomo-Text.lines.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.lines 3 2025-04-19T14:52:07.140150 "Tomo man-pages"
+.TH Text.lines 3 2025-04-21T14:44:34.264608 "Tomo man-pages"
.SH NAME
-Text.lines \- Splits the text into a list of lines of text, preserving blank lines, ignoring trailing newlines, and handling `\r\n` the same as `\n`.
-
+Text.lines \- get list of lines
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.lines\ :\ func(text:\ Text\ ->\ [Text])
.fi
-
.SH DESCRIPTION
Splits the text into a list of lines of text, preserving blank lines, ignoring trailing newlines, and handling `\r\n` the same as `\n`.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.lower.3 b/man/man3/tomo-Text.lower.3
index 41f412c3..7f68c9c7 100644
--- a/man/man3/tomo-Text.lower.3
+++ b/man/man3/tomo-Text.lower.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.lower 3 2025-04-19T14:52:07.140186 "Tomo man-pages"
+.TH Text.lower 3 2025-04-21T14:44:34.264642 "Tomo man-pages"
.SH NAME
-Text.lower \- Converts all characters in the text to lowercase.
-
+Text.lower \- convert to lowercase
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.lower\ :\ func(text:\ Text,\ language:\ Text\ =\ "C"\ ->\ Text)
.fi
-
.SH DESCRIPTION
Converts all characters in the text to lowercase.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.middle_pad.3 b/man/man3/tomo-Text.middle_pad.3
index d27cf3d4..bb70a36d 100644
--- a/man/man3/tomo-Text.middle_pad.3
+++ b/man/man3/tomo-Text.middle_pad.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.middle_pad 3 2025-04-19T14:52:07.140072 "Tomo man-pages"
+.TH Text.middle_pad 3 2025-04-21T14:44:34.264537 "Tomo man-pages"
.SH NAME
-Text.middle_pad \- Pad some text on the left and right side so it reaches a target width.
-
+Text.middle_pad \- pad text, centered
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.middle_pad\ :\ func(text:\ Text,\ width:\ Int,\ pad:\ Text\ =\ "\ ",\ language:\ Text\ =\ "C"\ ->\ Text)
.fi
-
.SH DESCRIPTION
Pad some text on the left and right side so it reaches a target width.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.quoted.3 b/man/man3/tomo-Text.quoted.3
index 72f9321d..e770c26f 100644
--- a/man/man3/tomo-Text.quoted.3
+++ b/man/man3/tomo-Text.quoted.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.quoted 3 2025-04-19T14:52:07.140226 "Tomo man-pages"
+.TH Text.quoted 3 2025-04-21T14:44:34.264678 "Tomo man-pages"
.SH NAME
-Text.quoted \- Formats the text with quotation marks and escapes.
-
+Text.quoted \- add quotation marks and escapes
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.quoted\ :\ func(text:\ Text,\ color:\ Bool\ =\ no,\ quotation_mark:\ Text\ =\ `"`\ ->\ Text)
.fi
-
.SH DESCRIPTION
Formats the text with quotation marks and escapes.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.repeat.3 b/man/man3/tomo-Text.repeat.3
index 0bea8750..88942872 100644
--- a/man/man3/tomo-Text.repeat.3
+++ b/man/man3/tomo-Text.repeat.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.repeat 3 2025-04-19T14:52:07.140264 "Tomo man-pages"
+.TH Text.repeat 3 2025-04-21T14:44:34.264712 "Tomo man-pages"
.SH NAME
-Text.repeat \- Repeat some text multiple times.
-
+Text.repeat \- repeat text
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.repeat\ :\ func(text:\ Text,\ count:\ Int\ ->\ Text)
.fi
-
.SH DESCRIPTION
Repeat some text multiple times.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.replace.3 b/man/man3/tomo-Text.replace.3
index 33930ef5..1dc30870 100644
--- a/man/man3/tomo-Text.replace.3
+++ b/man/man3/tomo-Text.replace.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.replace 3 2025-04-19T14:52:07.140299 "Tomo man-pages"
+.TH Text.replace 3 2025-04-21T14:44:34.264751 "Tomo man-pages"
.SH NAME
-Text.replace \- Replaces occurrences of a target text with a replacement text.
-
+Text.replace \- replace a substring
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.replace\ :\ func(text:\ Text,\ target:\ Text,\ replacement:\ Text\ ->\ Text)
.fi
-
.SH DESCRIPTION
Replaces occurrences of a target text with a replacement text.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.reversed.3 b/man/man3/tomo-Text.reversed.3
index a6f2b748..68fe7a07 100644
--- a/man/man3/tomo-Text.reversed.3
+++ b/man/man3/tomo-Text.reversed.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.reversed 3 2025-04-19T14:52:07.140334 "Tomo man-pages"
+.TH Text.reversed 3 2025-04-21T14:44:34.264790 "Tomo man-pages"
.SH NAME
-Text.reversed \- Return a text that has the grapheme clusters in reverse order.
-
+Text.reversed \- get a reversed copy
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.reversed\ :\ func(text:\ Text\ ->\ Text)
.fi
-
.SH DESCRIPTION
Return a text that has the grapheme clusters in reverse order.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.right_pad.3 b/man/man3/tomo-Text.right_pad.3
index 145c7f47..43fb909d 100644
--- a/man/man3/tomo-Text.right_pad.3
+++ b/man/man3/tomo-Text.right_pad.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.right_pad 3 2025-04-19T14:52:07.140368 "Tomo man-pages"
+.TH Text.right_pad 3 2025-04-21T14:44:34.264822 "Tomo man-pages"
.SH NAME
-Text.right_pad \- Pad some text on the right side so it reaches a target width.
-
+Text.right_pad \- right-pad text
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.right_pad\ :\ func(text:\ Text,\ width:\ Int,\ pad:\ Text\ =\ "\ ",\ language:\ Text\ =\ "C"\ ->\ Text)
.fi
-
.SH DESCRIPTION
Pad some text on the right side so it reaches a target width.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.slice.3 b/man/man3/tomo-Text.slice.3
index 73b7aa4d..2b00914a 100644
--- a/man/man3/tomo-Text.slice.3
+++ b/man/man3/tomo-Text.slice.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.slice 3 2025-04-19T14:52:07.140407 "Tomo man-pages"
+.TH Text.slice 3 2025-04-21T14:44:34.264861 "Tomo man-pages"
.SH NAME
-Text.slice \- Get a slice of the text.
-
+Text.slice \- get a slice of a text
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.slice\ :\ func(text:\ Text,\ from:\ Int\ =\ 1,\ to:\ Int\ =\ -1\ ->\ Text)
.fi
-
.SH DESCRIPTION
Get a slice of the text.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.split.3 b/man/man3/tomo-Text.split.3
index fd9b2806..23a9c921 100644
--- a/man/man3/tomo-Text.split.3
+++ b/man/man3/tomo-Text.split.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.split 3 2025-04-19T14:52:07.140467 "Tomo man-pages"
+.TH Text.split 3 2025-04-21T14:44:34.264909 "Tomo man-pages"
.SH NAME
-Text.split \- Splits the text into a list of substrings based on exact matches of a delimiter.
-
+Text.split \- split a text by a delimiter
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.split\ :\ func(text:\ Text,\ delimiter:\ Text\ =\ ""\ ->\ [Text])
.fi
-
.SH DESCRIPTION
Splits the text into a list of substrings based on exact matches of a delimiter.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.split_any.3 b/man/man3/tomo-Text.split_any.3
index 8291c024..5552a34f 100644
--- a/man/man3/tomo-Text.split_any.3
+++ b/man/man3/tomo-Text.split_any.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.split_any 3 2025-04-19T14:52:07.140522 "Tomo man-pages"
+.TH Text.split_any 3 2025-04-21T14:44:34.264947 "Tomo man-pages"
.SH NAME
-Text.split_any \- Splits the text into a list of substrings at one or more occurrences of a set of delimiter characters (grapheme clusters).
-
+Text.split_any \- split a text by multiple delimiters
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.split_any\ :\ func(text:\ Text,\ delimiters:\ Text\ =\ "\ $\[rs]t\[rs]r\[rs]n"\ ->\ [Text])
.fi
-
.SH DESCRIPTION
Splits the text into a list of substrings at one or more occurrences of a set of delimiter characters (grapheme clusters).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.starts_with.3 b/man/man3/tomo-Text.starts_with.3
index 20fa028e..9889e326 100644
--- a/man/man3/tomo-Text.starts_with.3
+++ b/man/man3/tomo-Text.starts_with.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.starts_with 3 2025-04-19T14:52:07.140568 "Tomo man-pages"
+.TH Text.starts_with 3 2025-04-21T14:44:34.264983 "Tomo man-pages"
.SH NAME
-Text.starts_with \- Checks if the `Text` starts with a literal prefix text.
-
+Text.starts_with \- check prefix
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.starts_with\ :\ func(text:\ Text,\ prefix:\ Text\ ->\ Bool)
.fi
-
.SH DESCRIPTION
Checks if the `Text` starts with a literal prefix text.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.title.3 b/man/man3/tomo-Text.title.3
index 9a09a729..54e3e3f4 100644
--- a/man/man3/tomo-Text.title.3
+++ b/man/man3/tomo-Text.title.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.title 3 2025-04-19T14:52:07.140604 "Tomo man-pages"
+.TH Text.title 3 2025-04-21T14:44:34.265018 "Tomo man-pages"
.SH NAME
-Text.title \- Converts the text to title case (capitalizing the first letter of each word).
-
+Text.title \- titlecase
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.title\ :\ func(text:\ Text,\ language:\ Text\ =\ "C"\ ->\ Text)
.fi
-
.SH DESCRIPTION
Converts the text to title case (capitalizing the first letter of each word).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.to.3 b/man/man3/tomo-Text.to.3
index efb70ec5..82c232e3 100644
--- a/man/man3/tomo-Text.to.3
+++ b/man/man3/tomo-Text.to.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.to 3 2025-04-19T14:52:07.140645 "Tomo man-pages"
+.TH Text.to 3 2025-04-21T14:44:34.265057 "Tomo man-pages"
.SH NAME
-Text.to \- Get a slice of the text, ending at the given position.
-
+Text.to \- slice to an end index
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.to\ :\ func(text:\ Text,\ last:\ Int\ ->\ Text)
.fi
-
.SH DESCRIPTION
Get a slice of the text, ending at the given position.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.translate.3 b/man/man3/tomo-Text.translate.3
index de0f79ba..83fcf74b 100644
--- a/man/man3/tomo-Text.translate.3
+++ b/man/man3/tomo-Text.translate.3
@@ -2,26 +2,27 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.translate 3 2025-04-19T14:52:07.140684 "Tomo man-pages"
+.TH Text.translate 3 2025-04-21T14:44:34.265097 "Tomo man-pages"
.SH NAME
-Text.translate \- Takes a table mapping target texts to their replacements and performs all the replacements in the table on the whole text. At each position, the first matching replacement is applied and the matching moves on to *after* the replacement text, so replacement text is not recursively modified. See Text.replace() for more information about replacement behavior.
-
+Text.translate \- perform multiple replacements
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
-.BI Text.translate\ :\ func(translations:\ {Text=Text}\ ->\ Text)
+.BI Text.translate\ :\ func(text:\ Text,\ translations:\ {Text=Text}\ ->\ Text)
.fi
-
.SH DESCRIPTION
Takes a table mapping target texts to their replacements and performs all the replacements in the table on the whole text. At each position, the first matching replacement is applied and the matching moves on to *after* the replacement text, so replacement text is not recursively modified. See Text.replace() for more information about replacement behavior.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
l l l l.
Name Type Description Default
+text Text The text to be translated. -
translations {Text=Text} A table mapping from target text to its replacement. -
.TE
.SH RETURN
@@ -30,11 +31,11 @@ The text with all occurrences of the targets replaced with their corresponding r
.SH EXAMPLES
.EX
>> "A <tag> & an amperand".translate({
-"&" = "&amp;",
-"<" = "&lt;",
-">" = "&gt;",
-\&'"" = "&quot",
-"'" = "&#39;",
-}
+ "&" = "&amp;",
+ "<" = "&lt;",
+ ">" = "&gt;",
+ '"" = "&quot",
+ "'" = "&#39;",
+})
= "A &lt;tag&gt; &amp; an ampersand"
.EE
diff --git a/man/man3/tomo-Text.trim.3 b/man/man3/tomo-Text.trim.3
index 13adf435..cb3931fb 100644
--- a/man/man3/tomo-Text.trim.3
+++ b/man/man3/tomo-Text.trim.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.trim 3 2025-04-19T14:52:07.140723 "Tomo man-pages"
+.TH Text.trim 3 2025-04-21T14:44:34.265139 "Tomo man-pages"
.SH NAME
-Text.trim \- Trims the given characters (grapheme clusters) from the left and/or right side of the text.
-
+Text.trim \- trim characters
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.trim\ :\ func(text:\ Text,\ to_trim:\ Text\ =\ "\ $\[rs]t\[rs]r\[rs]n",\ left:\ Bool\ =\ yes,\ right:\ Bool\ =\ yes\ ->\ Text)
.fi
-
.SH DESCRIPTION
Trims the given characters (grapheme clusters) from the left and/or right side of the text.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.upper.3 b/man/man3/tomo-Text.upper.3
index c996776c..6ad0f840 100644
--- a/man/man3/tomo-Text.upper.3
+++ b/man/man3/tomo-Text.upper.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.upper 3 2025-04-19T14:52:07.140764 "Tomo man-pages"
+.TH Text.upper 3 2025-04-21T14:44:34.265176 "Tomo man-pages"
.SH NAME
-Text.upper \- Converts all characters in the text to uppercase.
-
+Text.upper \- uppercase
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.upper\ :\ func(text:\ Text,\ language:\ Text\ =\ "C"\ ->\ Text)
.fi
-
.SH DESCRIPTION
Converts all characters in the text to uppercase.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.utf32_codepoints.3 b/man/man3/tomo-Text.utf32_codepoints.3
index 8879ddf1..6e815001 100644
--- a/man/man3/tomo-Text.utf32_codepoints.3
+++ b/man/man3/tomo-Text.utf32_codepoints.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.utf32_codepoints 3 2025-04-19T14:52:07.140801 "Tomo man-pages"
+.TH Text.utf32_codepoints 3 2025-04-21T14:44:34.265211 "Tomo man-pages"
.SH NAME
-Text.utf32_codepoints \- Returns a list of Unicode code points for UTF32 encoding of the text.
-
+Text.utf32_codepoints \- get UTF32 codepoints
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.utf32_codepoints\ :\ func(text:\ Text\ ->\ [Int32])
.fi
-
.SH DESCRIPTION
Returns a list of Unicode code points for UTF32 encoding of the text.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.width.3 b/man/man3/tomo-Text.width.3
index a4dff67b..c9dbdcf5 100644
--- a/man/man3/tomo-Text.width.3
+++ b/man/man3/tomo-Text.width.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.width 3 2025-04-19T14:52:07.140841 "Tomo man-pages"
+.TH Text.width 3 2025-04-21T14:44:34.265245 "Tomo man-pages"
.SH NAME
-Text.width \- Returns the display width of the text as seen in a terminal with appropriate font rendering. This is usually the same as the text's `.length`, but there are some characters like emojis that render wider than 1 cell.
-
+Text.width \- get display width
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.width\ :\ func(text:\ Text\ ->\ Int)
.fi
-
.SH DESCRIPTION
Returns the display width of the text as seen in a terminal with appropriate font rendering. This is usually the same as the text's `.length`, but there are some characters like emojis that render wider than 1 cell.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.without_prefix.3 b/man/man3/tomo-Text.without_prefix.3
index 639517bd..33e4bc70 100644
--- a/man/man3/tomo-Text.without_prefix.3
+++ b/man/man3/tomo-Text.without_prefix.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.without_prefix 3 2025-04-19T14:52:07.140880 "Tomo man-pages"
+.TH Text.without_prefix 3 2025-04-21T14:44:34.265279 "Tomo man-pages"
.SH NAME
-Text.without_prefix \- Returns the text with a given prefix removed (if present).
-
+Text.without_prefix \- remove prefix
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.without_prefix\ :\ func(text:\ Text,\ prefix:\ Text\ ->\ Text)
.fi
-
.SH DESCRIPTION
Returns the text with a given prefix removed (if present).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-Text.without_suffix.3 b/man/man3/tomo-Text.without_suffix.3
index 5e6f3a21..f1d3849d 100644
--- a/man/man3/tomo-Text.without_suffix.3
+++ b/man/man3/tomo-Text.without_suffix.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.without_suffix 3 2025-04-19T14:52:07.140916 "Tomo man-pages"
+.TH Text.without_suffix 3 2025-04-21T14:44:34.265312 "Tomo man-pages"
.SH NAME
-Text.without_suffix \- Returns the text with a given suffix removed (if present).
-
+Text.without_suffix \- remove suffix
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.without_suffix\ :\ func(text:\ Text,\ suffix:\ Text\ ->\ Text)
.fi
-
.SH DESCRIPTION
Returns the text with a given suffix removed (if present).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-USE_COLOR.3 b/man/man3/tomo-USE_COLOR.3
index cc4ef334..36727753 100644
--- a/man/man3/tomo-USE_COLOR.3
+++ b/man/man3/tomo-USE_COLOR.3
@@ -2,17 +2,16 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH USE_COLOR 3 2025-04-19T14:52:07.132537 "Tomo man-pages"
+.TH USE_COLOR 3 2025-04-21T14:44:34.257755 "Tomo man-pages"
.SH NAME
-USE_COLOR \- Whether or not the console prefers ANSI color escape sequences in the output.
-
+USE_COLOR \- whether to use colors
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI USE_COLOR\ :\ Bool
.fi
-
.SH DESCRIPTION
Whether or not the console prefers ANSI color escape sequences in the output.
+
diff --git a/man/man3/tomo-ask.3 b/man/man3/tomo-ask.3
index 7f913b26..03224d6f 100644
--- a/man/man3/tomo-ask.3
+++ b/man/man3/tomo-ask.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH ask 3 2025-04-19T14:52:07.132150 "Tomo man-pages"
+.TH ask 3 2025-04-21T14:44:34.257389 "Tomo man-pages"
.SH NAME
-ask \- Gets a line of user input text with a prompt.
-
+ask \- get user input
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI ask\ :\ func(prompt:\ Text,\ bold:\ Bool\ =\ yes,\ force_tty:\ Bool\ =\ yes\ ->\ Text?)
.fi
-
.SH DESCRIPTION
Gets a line of user input text with a prompt.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-exit.3 b/man/man3/tomo-exit.3
index ea422e3e..faf2ebb4 100644
--- a/man/man3/tomo-exit.3
+++ b/man/man3/tomo-exit.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH exit 3 2025-04-19T14:52:07.132214 "Tomo man-pages"
+.TH exit 3 2025-04-21T14:44:34.257450 "Tomo man-pages"
.SH NAME
-exit \- Exits the program with a given status and optionally prints a message.
-
+exit \- exit the program
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI exit\ :\ func(message:\ Text?\ =\ !Text,\ status:\ Int32\ =\ Int32(1)\ ->\ Void)
.fi
-
.SH DESCRIPTION
Exits the program with a given status and optionally prints a message.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-fail.3 b/man/man3/tomo-fail.3
index 58454f8f..8d37decd 100644
--- a/man/man3/tomo-fail.3
+++ b/man/man3/tomo-fail.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH fail 3 2025-04-19T14:52:07.132497 "Tomo man-pages"
+.TH fail 3 2025-04-21T14:44:34.257711 "Tomo man-pages"
.SH NAME
-fail \- Prints a message to the console, aborts the program, and prints a stack trace.
-
+fail \- abort the program
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI fail\ :\ func(message:\ Text\ ->\ Abort)
.fi
-
.SH DESCRIPTION
Prints a message to the console, aborts the program, and prints a stack trace.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-getenv.3 b/man/man3/tomo-getenv.3
index 105cd8f5..ead41d07 100644
--- a/man/man3/tomo-getenv.3
+++ b/man/man3/tomo-getenv.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH getenv 3 2025-04-19T14:52:07.132271 "Tomo man-pages"
+.TH getenv 3 2025-04-21T14:44:34.257502 "Tomo man-pages"
.SH NAME
-getenv \- Gets an environment variable.
-
+getenv \- get an environment variable
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI getenv\ :\ func(name:\ Text\ ->\ Text?)
.fi
-
.SH DESCRIPTION
Gets an environment variable.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-print.3 b/man/man3/tomo-print.3
index a3dc6686..4f960069 100644
--- a/man/man3/tomo-print.3
+++ b/man/man3/tomo-print.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH print 3 2025-04-19T14:52:07.132314 "Tomo man-pages"
+.TH print 3 2025-04-21T14:44:34.257546 "Tomo man-pages"
.SH NAME
-print \- Prints a message to the console (alias for say()).
-
+print \- print some text
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI print\ :\ func(text:\ Text,\ newline:\ Bool\ =\ yes\ ->\ Void)
.fi
-
.SH DESCRIPTION
Prints a message to the console (alias for say()).
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-say.3 b/man/man3/tomo-say.3
index 9e394cb6..41ca5599 100644
--- a/man/man3/tomo-say.3
+++ b/man/man3/tomo-say.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH say 3 2025-04-19T14:52:07.132365 "Tomo man-pages"
+.TH say 3 2025-04-21T14:44:34.257589 "Tomo man-pages"
.SH NAME
-say \- Prints a message to the console.
-
+say \- print some text
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI say\ :\ func(text:\ Text,\ newline:\ Bool\ =\ yes\ ->\ Void)
.fi
-
.SH DESCRIPTION
Prints a message to the console.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-setenv.3 b/man/man3/tomo-setenv.3
index b06d4c8c..3900edb6 100644
--- a/man/man3/tomo-setenv.3
+++ b/man/man3/tomo-setenv.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH setenv 3 2025-04-19T14:52:07.132411 "Tomo man-pages"
+.TH setenv 3 2025-04-21T14:44:34.257633 "Tomo man-pages"
.SH NAME
-setenv \- Sets an environment variable.
-
+setenv \- set an environment variable
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI setenv\ :\ func(name:\ Text,\ value:\ Text\ ->\ Void)
.fi
-
.SH DESCRIPTION
Sets an environment variable.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb
diff --git a/man/man3/tomo-sleep.3 b/man/man3/tomo-sleep.3
index c75e7652..782c8f57 100644
--- a/man/man3/tomo-sleep.3
+++ b/man/man3/tomo-sleep.3
@@ -2,21 +2,21 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH sleep 3 2025-04-19T14:52:07.132449 "Tomo man-pages"
+.TH sleep 3 2025-04-21T14:44:34.257676 "Tomo man-pages"
.SH NAME
-sleep \- Pause execution for a given number of seconds.
-
+sleep \- wait for an interval
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI sleep\ :\ func(seconds:\ Num\ ->\ Void)
.fi
-
.SH DESCRIPTION
Pause execution for a given number of seconds.
+.SH ARGUMENTS
+
.TS
allbox;
lb lb lbx lb