diff options
| author | Bruce Hill <bruce@bruce-hill.com> | 2025-09-21 23:23:59 -0400 |
|---|---|---|
| committer | Bruce Hill <bruce@bruce-hill.com> | 2025-09-21 23:23:59 -0400 |
| commit | 5824a2ef19879c59866667aced6b3f90e5925648 (patch) | |
| tree | a18ddeadb0c164c7a544b571c3968f86afb759ba /man | |
| parent | bf067544e98f4085c26161953e301aaa00a904df (diff) | |
Update docs with proper assertions
Diffstat (limited to 'man')
167 files changed, 516 insertions, 825 deletions
diff --git a/man/man3/tomo-Bool.parse.3 b/man/man3/tomo-Bool.parse.3 index e1d5f3b7..8fe9f2dd 100644 --- a/man/man3/tomo-Bool.parse.3 +++ b/man/man3/tomo-Bool.parse.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Bool.parse 3 2025-08-16 "Tomo man-pages" +.TH Bool.parse 3 2025-09-21 "Tomo man-pages" .SH NAME Bool.parse \- parse into boolean .SH LIBRARY @@ -30,18 +30,12 @@ remainder &Text? If non-none, this argument will be set to the remainder of the .SH EXAMPLES .EX ->> Bool.parse("yes") -= yes : Bool? ->> Bool.parse("no") -= no : Bool? ->> Bool.parse("???") -= none : Bool? +assert Bool.parse("yes") == yes +assert Bool.parse("no") == no +assert Bool.parse("???") == none ->> Bool.parse("yesJUNK") -= none : Bool? +assert Bool.parse("yesJUNK") == none remainder : Text ->> Bool.parse("yesJUNK", &remainder) -= yes : Bool? ->> remainder -= "JUNK" +assert Bool.parse("yesJUNK", &remainder) == yes +assert remainder == "JUNK" .EE diff --git a/man/man3/tomo-Byte.get_bit.3 b/man/man3/tomo-Byte.get_bit.3 index 85d6c2ae..b815e9d4 100644 --- a/man/man3/tomo-Byte.get_bit.3 +++ b/man/man3/tomo-Byte.get_bit.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Byte.get_bit 3 2025-06-26 "Tomo man-pages" +.TH Byte.get_bit 3 2025-09-21 "Tomo man-pages" .SH NAME Byte.get_bit \- check whether a bit is set .SH LIBRARY @@ -33,12 +33,8 @@ The bit index must be between 1-8 or a runtime error will be produced. .SH EXAMPLES .EX ->> Byte(6).get_bit(1) -= no ->> Byte(6).get_bit(2) -= yes ->> Byte(6).get_bit(3) -= yes ->> Byte(6).get_bit(4) -= no +assert Byte(6).get_bit(1) == no +assert Byte(6).get_bit(2) == yes +assert Byte(6).get_bit(3) == yes +assert Byte(6).get_bit(4) == no .EE diff --git a/man/man3/tomo-Byte.hex.3 b/man/man3/tomo-Byte.hex.3 index 6b19e82c..c09ba5c1 100644 --- a/man/man3/tomo-Byte.hex.3 +++ b/man/man3/tomo-Byte.hex.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Byte.hex 3 2025-04-30 "Tomo man-pages" +.TH Byte.hex 3 2025-09-21 "Tomo man-pages" .SH NAME Byte.hex \- convert to hexidecimal .SH LIBRARY @@ -31,6 +31,5 @@ The byte as a hexidecimal text. .SH EXAMPLES .EX ->> Byte(18).hex() -= "0x12" +assert Byte(18).hex() == "0x12" .EE diff --git a/man/man3/tomo-Byte.is_between.3 b/man/man3/tomo-Byte.is_between.3 index 9169d998..042747ac 100644 --- a/man/man3/tomo-Byte.is_between.3 +++ b/man/man3/tomo-Byte.is_between.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Byte.is_between 3 2025-04-30 "Tomo man-pages" +.TH Byte.is_between 3 2025-09-21 "Tomo man-pages" .SH NAME Byte.is_between \- test if inside a range .SH LIBRARY @@ -31,10 +31,7 @@ high Byte The upper bound to check (inclusive). - .SH EXAMPLES .EX ->> Byte(7).is_between(1, 10) -= yes ->> Byte(7).is_between(100, 200) -= no ->> Byte(7).is_between(1, 7) -= yes +assert Byte(7).is_between(1, 10) == yes +assert Byte(7).is_between(100, 200) == no +assert Byte(7).is_between(1, 7) == yes .EE diff --git a/man/man3/tomo-Byte.parse.3 b/man/man3/tomo-Byte.parse.3 index 1beeb3a4..57dbaee2 100644 --- a/man/man3/tomo-Byte.parse.3 +++ b/man/man3/tomo-Byte.parse.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Byte.parse 3 2025-08-16 "Tomo man-pages" +.TH Byte.parse 3 2025-09-21 "Tomo man-pages" .SH NAME Byte.parse \- convert text to a byte .SH LIBRARY @@ -30,16 +30,11 @@ The byte parsed from the text, if successful, otherwise `none`. .SH EXAMPLES .EX ->> Byte.parse("5") -= Byte(5) : Byte? ->> Byte.parse("asdf") -= none : Byte? +assert Byte.parse("5") == Byte(5) +assert Byte.parse("asdf") == none +assert Byte.parse("123xyz") == none ->> Byte.parse("123xyz") -= none : Byte? remainder : Text ->> Byte.parse("123xyz", &remainder) -= Byte(123) : Byte? ->> remainder -= "xyz" +assert Byte.parse("123xyz", &remainder) == Byte(123) +assert remainder == "xyz" .EE diff --git a/man/man3/tomo-Int.abs.3 b/man/man3/tomo-Int.abs.3 index 3deb6928..d5f212cd 100644 --- a/man/man3/tomo-Int.abs.3 +++ b/man/man3/tomo-Int.abs.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Int.abs 3 2025-04-30 "Tomo man-pages" +.TH Int.abs 3 2025-09-21 "Tomo man-pages" .SH NAME Int.abs \- absolute value .SH LIBRARY @@ -29,6 +29,5 @@ The absolute value of `x`. .SH EXAMPLES .EX ->> (-10).abs() -= 10 +assert (-10).abs() == 10 .EE diff --git a/man/man3/tomo-Int.choose.3 b/man/man3/tomo-Int.choose.3 index 57a79540..5d178732 100644 --- a/man/man3/tomo-Int.choose.3 +++ b/man/man3/tomo-Int.choose.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Int.choose 3 2025-04-30 "Tomo man-pages" +.TH Int.choose 3 2025-09-21 "Tomo man-pages" .SH NAME Int.choose \- binomial coefficient .SH LIBRARY @@ -30,6 +30,5 @@ The binomial coefficient, equivalent to the number of ways to uniquely choose `k .SH EXAMPLES .EX ->> (4).choose(2) -= 6 +assert (4).choose(2) == 6 .EE diff --git a/man/man3/tomo-Int.clamped.3 b/man/man3/tomo-Int.clamped.3 index d951f76b..fbfe9fa8 100644 --- a/man/man3/tomo-Int.clamped.3 +++ b/man/man3/tomo-Int.clamped.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Int.clamped 3 2025-04-30 "Tomo man-pages" +.TH Int.clamped 3 2025-09-21 "Tomo man-pages" .SH NAME Int.clamped \- clamp an integer .SH LIBRARY @@ -31,6 +31,5 @@ The first argument clamped between the other two arguments. .SH EXAMPLES .EX ->> (2).clamped(5, 10) -= 5 +assert (2).clamped(5, 10) == 5 .EE diff --git a/man/man3/tomo-Int.factorial.3 b/man/man3/tomo-Int.factorial.3 index eba61613..34efbfa2 100644 --- a/man/man3/tomo-Int.factorial.3 +++ b/man/man3/tomo-Int.factorial.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Int.factorial 3 2025-04-30 "Tomo man-pages" +.TH Int.factorial 3 2025-09-21 "Tomo man-pages" .SH NAME Int.factorial \- factorial .SH LIBRARY @@ -29,6 +29,5 @@ The factorial of the given integer. .SH EXAMPLES .EX ->> (10).factorial() -= 3628800 +assert (10).factorial() == 3628800 .EE diff --git a/man/man3/tomo-Int.get_bit.3 b/man/man3/tomo-Int.get_bit.3 index e0b98909..d2009d58 100644 --- a/man/man3/tomo-Int.get_bit.3 +++ b/man/man3/tomo-Int.get_bit.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Int.get_bit 3 2025-06-25 "Tomo man-pages" +.TH Int.get_bit 3 2025-09-21 "Tomo man-pages" .SH NAME Int.get_bit \- check whether a bit is set .SH LIBRARY @@ -33,12 +33,8 @@ For fixed-size integers, the bit index must be between 1 and the number of bits .SH EXAMPLES .EX ->> (6).get_bit(1) -= no ->> (6).get_bit(2) -= yes ->> (6).get_bit(3) -= yes ->> (6).get_bit(4) -= no +assert (6).get_bit(1) == no +assert (6).get_bit(2) == yes +assert (6).get_bit(3) == yes +assert (6).get_bit(4) == no .EE diff --git a/man/man3/tomo-Int.hex.3 b/man/man3/tomo-Int.hex.3 index c91f22b4..fcfee9de 100644 --- a/man/man3/tomo-Int.hex.3 +++ b/man/man3/tomo-Int.hex.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Int.hex 3 2025-04-30 "Tomo man-pages" +.TH Int.hex 3 2025-09-21 "Tomo man-pages" .SH NAME Int.hex \- convert to hexidecimal .SH LIBRARY @@ -32,6 +32,5 @@ The hexadecimal string representation of the integer. .SH EXAMPLES .EX ->> (255).hex(digits=4, uppercase=yes, prefix=yes) -= "0x00FF" +assert (255).hex(digits=4, uppercase=yes, prefix=yes) == "0x00FF" .EE diff --git a/man/man3/tomo-Int.is_between.3 b/man/man3/tomo-Int.is_between.3 index 1f445b12..41c84c15 100644 --- a/man/man3/tomo-Int.is_between.3 +++ b/man/man3/tomo-Int.is_between.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Int.is_between 3 2025-04-30 "Tomo man-pages" +.TH Int.is_between 3 2025-09-21 "Tomo man-pages" .SH NAME Int.is_between \- test if an int is in a range .SH LIBRARY @@ -31,10 +31,7 @@ high Int The upper bound to check (inclusive). - .SH EXAMPLES .EX ->> (7).is_between(1, 10) -= yes ->> (7).is_between(100, 200) -= no ->> (7).is_between(1, 7) -= yes +assert (7).is_between(1, 10) == yes +assert (7).is_between(100, 200) == no +assert (7).is_between(1, 7) == yes .EE diff --git a/man/man3/tomo-Int.is_prime.3 b/man/man3/tomo-Int.is_prime.3 index 27769976..d5adbac8 100644 --- a/man/man3/tomo-Int.is_prime.3 +++ b/man/man3/tomo-Int.is_prime.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Int.is_prime 3 2025-04-30 "Tomo man-pages" +.TH Int.is_prime 3 2025-09-21 "Tomo man-pages" .SH NAME Int.is_prime \- check if an integer is prime .SH LIBRARY @@ -33,8 +33,6 @@ This function is _probabilistic_. With the default arguments, the chances of get .SH EXAMPLES .EX ->> (7).is_prime() -= yes ->> (6).is_prime() -= no +assert (7).is_prime() == yes +assert (6).is_prime() == no .EE diff --git a/man/man3/tomo-Int.next_prime.3 b/man/man3/tomo-Int.next_prime.3 index 9904456a..bac4e2ed 100644 --- a/man/man3/tomo-Int.next_prime.3 +++ b/man/man3/tomo-Int.next_prime.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Int.next_prime 3 2025-04-30 "Tomo man-pages" +.TH Int.next_prime 3 2025-09-21 "Tomo man-pages" .SH NAME Int.next_prime \- get the next prime .SH LIBRARY @@ -32,6 +32,5 @@ This function is _probabilistic_, but the chances of getting an incorrect answer .SH EXAMPLES .EX ->> (11).next_prime() -= 13 +assert (11).next_prime() == 13 .EE diff --git a/man/man3/tomo-Int.octal.3 b/man/man3/tomo-Int.octal.3 index 06c5dd23..3cd4f7f6 100644 --- a/man/man3/tomo-Int.octal.3 +++ b/man/man3/tomo-Int.octal.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Int.octal 3 2025-04-30 "Tomo man-pages" +.TH Int.octal 3 2025-09-21 "Tomo man-pages" .SH NAME Int.octal \- convert to octal .SH LIBRARY @@ -31,6 +31,5 @@ The octal string representation of the integer. .SH EXAMPLES .EX ->> (64).octal(digits=4, prefix=yes) -= "0o0100" +assert (64).octal(digits=4, prefix=yes) == "0o0100" .EE diff --git a/man/man3/tomo-Int.onward.3 b/man/man3/tomo-Int.onward.3 index 17cb4a6b..2b38014b 100644 --- a/man/man3/tomo-Int.onward.3 +++ b/man/man3/tomo-Int.onward.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Int.onward 3 2025-04-30 "Tomo man-pages" +.TH Int.onward 3 2025-09-21 "Tomo man-pages" .SH NAME Int.onward \- iterate from a number onward .SH LIBRARY @@ -34,6 +34,5 @@ nums : &[Int] = &[] for i in (5).onward() nums.insert(i) stop if i == 10 ->> nums[] -= [5, 6, 7, 8, 9, 10] +assert nums[] == [5, 6, 7, 8, 9, 10] .EE diff --git a/man/man3/tomo-Int.parse.3 b/man/man3/tomo-Int.parse.3 index 07a00e85..16793672 100644 --- a/man/man3/tomo-Int.parse.3 +++ b/man/man3/tomo-Int.parse.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Int.parse 3 2025-08-16 "Tomo man-pages" +.TH Int.parse 3 2025-09-21 "Tomo man-pages" .SH NAME Int.parse \- convert text to integer .SH LIBRARY @@ -30,24 +30,16 @@ The integer represented by the text. If the given text contains a value outside .SH EXAMPLES .EX ->> Int.parse("123") -= 123 : Int? ->> Int.parse("0xFF") -= 255 : Int? - ->> Int.parse("123xyz") -= none +assert Int.parse("123") == 123 +assert Int.parse("0xFF") == 255 +assert Int.parse("123xyz") == none remainder : Text ->> Int.parse("123xyz", &remainder) -= 123 : Int? ->> remainder -= "xyz" +assert Int.parse("123xyz", &remainder) == 123 +assert remainder == "xyz" # Can't parse: ->> Int.parse("asdf") -= none : Int? +assert Int.parse("asdf") == none # Outside valid range: ->> Int8.parse("9999999") -= none : Int8? +assert Int8.parse("9999999") == none .EE diff --git a/man/man3/tomo-Int.prev_prime.3 b/man/man3/tomo-Int.prev_prime.3 index 88cbc86a..3391de4e 100644 --- a/man/man3/tomo-Int.prev_prime.3 +++ b/man/man3/tomo-Int.prev_prime.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Int.prev_prime 3 2025-04-30 "Tomo man-pages" +.TH Int.prev_prime 3 2025-09-21 "Tomo man-pages" .SH NAME Int.prev_prime \- get the previous prime .SH LIBRARY @@ -32,6 +32,5 @@ This function is _probabilistic_, but the chances of getting an incorrect answer .SH EXAMPLES .EX ->> (11).prev_prime() -= 7 +assert (11).prev_prime() == 7 .EE diff --git a/man/man3/tomo-Int.sqrt.3 b/man/man3/tomo-Int.sqrt.3 index 99cd53e5..a2a66a09 100644 --- a/man/man3/tomo-Int.sqrt.3 +++ b/man/man3/tomo-Int.sqrt.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Int.sqrt 3 2025-04-30 "Tomo man-pages" +.TH Int.sqrt 3 2025-09-21 "Tomo man-pages" .SH NAME Int.sqrt \- square root .SH LIBRARY @@ -29,8 +29,6 @@ The integer part of the square root of `x`. .SH EXAMPLES .EX ->> (16).sqrt() -= 4 ->> (17).sqrt() -= 4 +assert (16).sqrt() == 4 +assert (17).sqrt() == 4 .EE diff --git a/man/man3/tomo-Int.to.3 b/man/man3/tomo-Int.to.3 index 2af4f5fd..ea8112bc 100644 --- a/man/man3/tomo-Int.to.3 +++ b/man/man3/tomo-Int.to.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Int.to 3 2025-04-30 "Tomo man-pages" +.TH Int.to 3 2025-09-21 "Tomo man-pages" .SH NAME Int.to \- iterate a range of integers .SH LIBRARY @@ -31,13 +31,14 @@ An iterator function that returns each integer in the given range (inclusive). .SH EXAMPLES .EX ->> (2).to(5) -= func(->Int?) ->> [x for x in (2).to(5)] -= [2, 3, 4, 5] ->> [x for x in (5).to(2)] -= [5, 4, 3, 2] +iter := (2).to(5) +assert iter() == 2 +assert iter() == 3 +assert iter() == 4 +assert iter() == 5 +assert iter() == none ->> [x for x in (2).to(5, step=2)] -= [2, 4] +assert [x for x in (2).to(5)] == [2, 3, 4, 5] +assert [x for x in (5).to(2)] == [5, 4, 3, 2] +assert [x for x in (2).to(5, step=2)] == [2, 4] .EE diff --git a/man/man3/tomo-List.binary_search.3 b/man/man3/tomo-List.binary_search.3 index bed89279..b2cb1759 100644 --- a/man/man3/tomo-List.binary_search.3 +++ b/man/man3/tomo-List.binary_search.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.binary_search 3 2025-04-30 "Tomo man-pages" +.TH List.binary_search 3 2025-09-21 "Tomo man-pages" .SH NAME List.binary_search \- binary search .SH LIBRARY @@ -30,12 +30,7 @@ Assuming the input list is sorted according to the given comparison function, re .SH EXAMPLES .EX ->> [1, 3, 5, 7, 9].binary_search(5) -= 3 - ->> [1, 3, 5, 7, 9].binary_search(-999) -= 1 - ->> [1, 3, 5, 7, 9].binary_search(999) -= 6 +assert [1, 3, 5, 7, 9].binary_search(5) == 3 +assert [1, 3, 5, 7, 9].binary_search(-999) == 1 +assert [1, 3, 5, 7, 9].binary_search(999) == 6 .EE diff --git a/man/man3/tomo-List.by.3 b/man/man3/tomo-List.by.3 index 54ac9695..4d201c43 100644 --- a/man/man3/tomo-List.by.3 +++ b/man/man3/tomo-List.by.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.by 3 2025-04-30 "Tomo man-pages" +.TH List.by 3 2025-09-21 "Tomo man-pages" .SH NAME List.by \- slice by a step value .SH LIBRARY @@ -30,6 +30,5 @@ A new list with every `step`-th element from the original list. .SH EXAMPLES .EX ->> [1, 2, 3, 4, 5, 6].by(2) -= [1, 3, 5] +assert [1, 2, 3, 4, 5, 6].by(2) == [1, 3, 5] .EE diff --git a/man/man3/tomo-List.counts.3 b/man/man3/tomo-List.counts.3 index 350e3044..5b6d9b1b 100644 --- a/man/man3/tomo-List.counts.3 +++ b/man/man3/tomo-List.counts.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.counts 3 2025-04-30 "Tomo man-pages" +.TH List.counts 3 2025-09-21 "Tomo man-pages" .SH NAME List.counts \- count occurrences .SH LIBRARY @@ -29,6 +29,5 @@ A table mapping each element to its count. .SH EXAMPLES .EX ->> [10, 20, 30, 30, 30].counts() -= {10=1, 20=1, 30=3} +assert [10, 20, 30, 30, 30].counts() == {10=1, 20=1, 30=3} .EE diff --git a/man/man3/tomo-List.find.3 b/man/man3/tomo-List.find.3 index 9a2ff609..65ae5926 100644 --- a/man/man3/tomo-List.find.3 +++ b/man/man3/tomo-List.find.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.find 3 2025-04-30 "Tomo man-pages" +.TH List.find 3 2025-09-21 "Tomo man-pages" .SH NAME List.find \- find an element's index .SH LIBRARY @@ -30,9 +30,6 @@ The index of the first occurrence or `none` if not found. .SH EXAMPLES .EX ->> [10, 20, 30, 40, 50].find(20) -= 2 : Int? - ->> [10, 20, 30, 40, 50].find(9999) -= none : Int? +assert [10, 20, 30, 40, 50].find(20) == 2 +assert [10, 20, 30, 40, 50].find(9999) == none .EE diff --git a/man/man3/tomo-List.from.3 b/man/man3/tomo-List.from.3 index e1df7793..a7a24cd6 100644 --- a/man/man3/tomo-List.from.3 +++ b/man/man3/tomo-List.from.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.from 3 2025-04-30 "Tomo man-pages" +.TH List.from 3 2025-09-21 "Tomo man-pages" .SH NAME List.from \- slice an array from a start index .SH LIBRARY @@ -30,6 +30,5 @@ A new list starting from the specified index. .SH EXAMPLES .EX ->> [10, 20, 30, 40, 50].from(3) -= [30, 40, 50] +assert [10, 20, 30, 40, 50].from(3) == [30, 40, 50] .EE diff --git a/man/man3/tomo-List.has.3 b/man/man3/tomo-List.has.3 index 7b46066b..96507253 100644 --- a/man/man3/tomo-List.has.3 +++ b/man/man3/tomo-List.has.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.has 3 2025-04-30 "Tomo man-pages" +.TH List.has 3 2025-09-21 "Tomo man-pages" .SH NAME List.has \- check for member .SH LIBRARY @@ -30,6 +30,5 @@ target T The element to check for. - .SH EXAMPLES .EX ->> [10, 20, 30].has(20) -= yes +assert [10, 20, 30].has(20) == yes .EE diff --git a/man/man3/tomo-List.heap_pop.3 b/man/man3/tomo-List.heap_pop.3 index 00527870..cd4e292a 100644 --- a/man/man3/tomo-List.heap_pop.3 +++ b/man/man3/tomo-List.heap_pop.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.heap_pop 3 2025-04-30 "Tomo man-pages" +.TH List.heap_pop 3 2025-09-21 "Tomo man-pages" .SH NAME List.heap_pop \- heap pop .SH LIBRARY @@ -30,8 +30,7 @@ The removed top element of the heap or `none` if the list is empty. .SH EXAMPLES .EX ->> my_heap := [30, 10, 20] ->> my_heap.heapify() ->> my_heap.heap_pop() -= 10 +my_heap := [30, 10, 20] +my_heap.heapify() +assert my_heap.heap_pop() == 10 .EE diff --git a/man/man3/tomo-List.insert.3 b/man/man3/tomo-List.insert.3 index 20d23ef2..0ab71a3f 100644 --- a/man/man3/tomo-List.insert.3 +++ b/man/man3/tomo-List.insert.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.insert 3 2025-04-30 "Tomo man-pages" +.TH List.insert 3 2025-09-21 "Tomo man-pages" .SH NAME List.insert \- add an item to a list .SH LIBRARY @@ -34,12 +34,10 @@ Since indices are 1-indexed and negative indices mean "starting from the back", .SH EXAMPLES .EX ->> list := [10, 20] ->> list.insert(30) ->> list -= [10, 20, 30] +list := [10, 20] +list.insert(30) +assert list == [10, 20, 30] ->> list.insert(999, at=2) ->> list -= [10, 999, 20, 30] +list.insert(999, at=2) +assert list == [10, 999, 20, 30] .EE diff --git a/man/man3/tomo-List.insert_all.3 b/man/man3/tomo-List.insert_all.3 index bd042209..795f4a2d 100644 --- a/man/man3/tomo-List.insert_all.3 +++ b/man/man3/tomo-List.insert_all.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.insert_all 3 2025-04-30 "Tomo man-pages" +.TH List.insert_all 3 2025-09-21 "Tomo man-pages" .SH NAME List.insert_all \- add multiple items to a list .SH LIBRARY @@ -36,10 +36,8 @@ Since indices are 1-indexed and negative indices mean "starting from the back", .EX list := [10, 20] list.insert_all([30, 40]) ->> list -= [10, 20, 30, 40] +assert list == [10, 20, 30, 40] list.insert_all([99, 100], at=2) ->> list -= [10, 99, 100, 20, 30, 40] +assert list == [10, 99, 100, 20, 30, 40] .EE diff --git a/man/man3/tomo-List.pop.3 b/man/man3/tomo-List.pop.3 index 1603d9b7..b157e0ac 100644 --- a/man/man3/tomo-List.pop.3 +++ b/man/man3/tomo-List.pop.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.pop 3 2025-04-30 "Tomo man-pages" +.TH List.pop 3 2025-09-21 "Tomo man-pages" .SH NAME List.pop \- pop an item from a list .SH LIBRARY @@ -33,15 +33,11 @@ Since negative indices are counted from the back, the default behavior is to pop .SH EXAMPLES .EX ->> list := [10, 20, 30, 40] +list := &[10, 20, 30, 40] ->> list.pop() -= 40 ->> list -= &[10, 20, 30] +assert list.pop() == 40 +assert list[] == [10, 20, 30] ->> list.pop(index=2) -= 20 ->> list -= &[10, 30] +assert list.pop(index=2) == 20 +assert list[] == [10, 30] .EE diff --git a/man/man3/tomo-List.random.3 b/man/man3/tomo-List.random.3 index 60713098..0c82bfd0 100644 --- a/man/man3/tomo-List.random.3 +++ b/man/man3/tomo-List.random.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.random 3 2025-04-30 "Tomo man-pages" +.TH List.random 3 2025-09-21 "Tomo man-pages" .SH NAME List.random \- pick a random element .SH LIBRARY @@ -30,6 +30,5 @@ A random element from the list. .SH EXAMPLES .EX ->> [10, 20, 30].random() -= 20 +assert [10, 20, 30].random() == 20 .EE diff --git a/man/man3/tomo-List.remove_at.3 b/man/man3/tomo-List.remove_at.3 index 0ff876c9..8e993931 100644 --- a/man/man3/tomo-List.remove_at.3 +++ b/man/man3/tomo-List.remove_at.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.remove_at 3 2025-04-30 "Tomo man-pages" +.TH List.remove_at 3 2025-09-21 "Tomo man-pages" .SH NAME List.remove_at \- remove an item by index .SH LIBRARY @@ -36,10 +36,8 @@ Since negative indices are counted from the back, the default behavior is to rem .EX list := [10, 20, 30, 40, 50] list.remove_at(2) ->> list -= [10, 30, 40, 50] +assert list == [10, 30, 40, 50] list.remove_at(2, count=2) ->> list -= [10, 50] +assert list == [10, 50] .EE diff --git a/man/man3/tomo-List.remove_item.3 b/man/man3/tomo-List.remove_item.3 index 24531400..02631ba6 100644 --- a/man/man3/tomo-List.remove_item.3 +++ b/man/man3/tomo-List.remove_item.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.remove_item 3 2025-04-30 "Tomo man-pages" +.TH List.remove_item 3 2025-09-21 "Tomo man-pages" .SH NAME List.remove_item \- remove an item by value .SH LIBRARY @@ -36,10 +36,8 @@ A negative `max_count` means "remove all occurrences". .EX list := [10, 20, 10, 20, 30] list.remove_item(10) ->> list -= [20, 20, 30] +assert list == [20, 20, 30] list.remove_item(20, max_count=1) ->> list -= [20, 30] +assert list == [20, 30] .EE diff --git a/man/man3/tomo-List.reversed.3 b/man/man3/tomo-List.reversed.3 index c0073391..2b84e333 100644 --- a/man/man3/tomo-List.reversed.3 +++ b/man/man3/tomo-List.reversed.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.reversed 3 2025-04-30 "Tomo man-pages" +.TH List.reversed 3 2025-09-21 "Tomo man-pages" .SH NAME List.reversed \- get a reversed list .SH LIBRARY @@ -29,6 +29,5 @@ A slice of the list with elements in reverse order. .SH EXAMPLES .EX ->> [10, 20, 30].reversed() -= [30, 20, 10] +assert [10, 20, 30].reversed() == [30, 20, 10] .EE diff --git a/man/man3/tomo-List.sample.3 b/man/man3/tomo-List.sample.3 index 538310f9..0e4d779c 100644 --- a/man/man3/tomo-List.sample.3 +++ b/man/man3/tomo-List.sample.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.sample 3 2025-04-30 "Tomo man-pages" +.TH List.sample 3 2025-09-21 "Tomo man-pages" .SH NAME List.sample \- weighted random choices .SH LIBRARY @@ -35,6 +35,5 @@ Errors will be raised if any of the following conditions occurs: - The given lis .SH EXAMPLES .EX ->> [10, 20, 30].sample(2, weights=[90%, 5%, 5%]) -= [10, 10] +assert [10, 20, 30].sample(2, weights=[90%, 5%, 5%]) == [10, 10] .EE diff --git a/man/man3/tomo-List.shuffled.3 b/man/man3/tomo-List.shuffled.3 index 6585cc0f..25e63154 100644 --- a/man/man3/tomo-List.shuffled.3 +++ b/man/man3/tomo-List.shuffled.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.shuffled 3 2025-04-30 "Tomo man-pages" +.TH List.shuffled 3 2025-09-21 "Tomo man-pages" .SH NAME List.shuffled \- return a shuffled list .SH LIBRARY @@ -30,6 +30,5 @@ A new list with shuffled elements. .SH EXAMPLES .EX ->> [10, 20, 30, 40].shuffled() -= [40, 10, 30, 20] +assert [10, 20, 30, 40].shuffled() == [40, 10, 30, 20] .EE diff --git a/man/man3/tomo-List.slice.3 b/man/man3/tomo-List.slice.3 index 73dddbc3..676e2a08 100644 --- a/man/man3/tomo-List.slice.3 +++ b/man/man3/tomo-List.slice.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.slice 3 2025-04-30 "Tomo man-pages" +.TH List.slice 3 2025-09-21 "Tomo man-pages" .SH NAME List.slice \- get a slice of a list .SH LIBRARY @@ -31,9 +31,6 @@ A new list spanning the given indices. Note: negative indices are counted from t .SH EXAMPLES .EX ->> [10, 20, 30, 40, 50].slice(2, 4) -= [20, 30, 40] - ->> [10, 20, 30, 40, 50].slice(-3, -2) -= [30, 40] +assert [10, 20, 30, 40, 50].slice(2, 4) == [20, 30, 40] +assert [10, 20, 30, 40, 50].slice(-3, -2) == [30, 40] .EE diff --git a/man/man3/tomo-List.sort.3 b/man/man3/tomo-List.sort.3 index 62b05b37..3957e9fe 100644 --- a/man/man3/tomo-List.sort.3 +++ b/man/man3/tomo-List.sort.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.sort 3 2025-04-30 "Tomo man-pages" +.TH List.sort 3 2025-09-21 "Tomo man-pages" .SH NAME List.sort \- sort a list .SH LIBRARY @@ -32,10 +32,8 @@ Nothing. .EX list := [40, 10, -30, 20] list.sort() ->> list -= [-30, 10, 20, 40] +assert list == [-30, 10, 20, 40] list.sort(func(a,b:&Int): a.abs() <> b.abs()) ->> list -= [10, 20, -30, 40] +assert list == [10, 20, -30, 40] .EE diff --git a/man/man3/tomo-List.sorted.3 b/man/man3/tomo-List.sorted.3 index 19277682..49d75ecd 100644 --- a/man/man3/tomo-List.sorted.3 +++ b/man/man3/tomo-List.sorted.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.sorted 3 2025-04-30 "Tomo man-pages" +.TH List.sorted 3 2025-09-21 "Tomo man-pages" .SH NAME List.sorted \- sorted copy of a list .SH LIBRARY @@ -30,9 +30,8 @@ A new list with sorted elements. .SH EXAMPLES .EX ->> [40, 10, -30, 20].sorted() -= [-30, 10, 20, 40] - ->> [40, 10, -30, 20].sorted(func(a,b:&Int): a.abs() <> b.abs()) -= [10, 20, -30, 40] +assert [40, 10, -30, 20].sorted() == [-30, 10, 20, 40] +assert [40, 10, -30, 20].sorted( + func(a,b:&Int): a.abs() <> b.abs() +) == [10, 20, -30, 40] .EE diff --git a/man/man3/tomo-List.to.3 b/man/man3/tomo-List.to.3 index 202ec0c7..5af2a6db 100644 --- a/man/man3/tomo-List.to.3 +++ b/man/man3/tomo-List.to.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.to 3 2025-04-30 "Tomo man-pages" +.TH List.to 3 2025-09-21 "Tomo man-pages" .SH NAME List.to \- slice a list to an end index .SH LIBRARY @@ -30,9 +30,6 @@ A new list containing elements from the start up to the specified index. .SH EXAMPLES .EX ->> [10, 20, 30, 40, 50].to(3) -= [10, 20, 30] - ->> [10, 20, 30, 40, 50].to(-2) -= [10, 20, 30, 40] +assert [10, 20, 30, 40, 50].to(3) == [10, 20, 30] +assert [10, 20, 30, 40, 50].to(-2) == [10, 20, 30, 40] .EE diff --git a/man/man3/tomo-List.unique.3 b/man/man3/tomo-List.unique.3 index e24c0ad6..cab945b8 100644 --- a/man/man3/tomo-List.unique.3 +++ b/man/man3/tomo-List.unique.3 @@ -2,17 +2,17 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.unique 3 2025-04-30 "Tomo man-pages" +.TH List.unique 3 2025-09-21 "Tomo man-pages" .SH NAME -List.unique \- convert a list to a set +List.unique \- get the unique items in a list .SH LIBRARY Tomo Standard Library .SH SYNOPSIS .nf -.BI List.unique\ :\ func(list:\ [T]\ ->\ |T|) +.BI List.unique\ :\ func(list:\ [T]\ ->\ [T]) .fi .SH DESCRIPTION -Returns a Set that contains the unique elements of the list. +Returns a list of the unique elements of the list. .SH ARGUMENTS @@ -25,10 +25,9 @@ Name Type Description Default list [T] The list to process. - .TE .SH RETURN -A set containing only unique elements from the list. +A list of the unique elements from the list. .SH EXAMPLES .EX ->> [10, 20, 10, 10, 30].unique() -= {10, 20, 30} +assert [10, 20, 10, 10, 30].unique() == [10, 20, 30] .EE diff --git a/man/man3/tomo-List.where.3 b/man/man3/tomo-List.where.3 index 8e0d50de..8d5c71ef 100644 --- a/man/man3/tomo-List.where.3 +++ b/man/man3/tomo-List.where.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH List.where 3 2025-04-30 "Tomo man-pages" +.TH List.where 3 2025-09-21 "Tomo man-pages" .SH NAME List.where \- find an index where a predicate matches .SH LIBRARY @@ -30,8 +30,6 @@ Returns the index of the first item where the predicate is true or `none` if no .SH EXAMPLES .EX ->> [4, 5, 6].where(func(i:&Int): i.is_prime()) -= 5 : Int? ->> [4, 6, 8].find(func(i:&Int): i.is_prime()) -= none : Int? +assert [4, 5, 6].where(func(i:&Int): i.is_prime()) == 5 +assert [4, 6, 8].find(func(i:&Int): i.is_prime()) == none .EE diff --git a/man/man3/tomo-Num.abs.3 b/man/man3/tomo-Num.abs.3 index c1f1bf31..425d43cb 100644 --- a/man/man3/tomo-Num.abs.3 +++ b/man/man3/tomo-Num.abs.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.abs 3 2025-04-30 "Tomo man-pages" +.TH Num.abs 3 2025-09-21 "Tomo man-pages" .SH NAME Num.abs \- absolute value .SH LIBRARY @@ -29,6 +29,5 @@ The absolute value of `n`. .SH EXAMPLES .EX ->> (-3.5).abs() -= 3.5 +assert (-3.5).abs() == 3.5 .EE diff --git a/man/man3/tomo-Num.acos.3 b/man/man3/tomo-Num.acos.3 index 78715179..819c43d3 100644 --- a/man/man3/tomo-Num.acos.3 +++ b/man/man3/tomo-Num.acos.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.acos 3 2025-04-30 "Tomo man-pages" +.TH Num.acos 3 2025-09-21 "Tomo man-pages" .SH NAME Num.acos \- arc cosine .SH LIBRARY @@ -29,6 +29,5 @@ The arc cosine of `x` in radians. .SH EXAMPLES .EX ->> (0.0).acos() // -> (π/2) -= 1.5708 +assert (0.0).acos() == 1.5708 .EE diff --git a/man/man3/tomo-Num.acosh.3 b/man/man3/tomo-Num.acosh.3 index c971dc0d..0899fff8 100644 --- a/man/man3/tomo-Num.acosh.3 +++ b/man/man3/tomo-Num.acosh.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.acosh 3 2025-04-30 "Tomo man-pages" +.TH Num.acosh 3 2025-09-21 "Tomo man-pages" .SH NAME Num.acosh \- arc hyperbolic cosine .SH LIBRARY @@ -29,6 +29,5 @@ The inverse hyperbolic cosine of `x`. .SH EXAMPLES .EX ->> (1.0).acosh() -= 0 +assert (1.0).acosh() == 0 .EE diff --git a/man/man3/tomo-Num.asin.3 b/man/man3/tomo-Num.asin.3 index 242dbe0b..529a974c 100644 --- a/man/man3/tomo-Num.asin.3 +++ b/man/man3/tomo-Num.asin.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.asin 3 2025-04-30 "Tomo man-pages" +.TH Num.asin 3 2025-09-21 "Tomo man-pages" .SH NAME Num.asin \- arc sine .SH LIBRARY @@ -29,6 +29,5 @@ The arc sine of `x` in radians. .SH EXAMPLES .EX ->> (0.5).asin() // -> (π/6) -= 0.5236 +assert (0.5).asin() == 0.5236 .EE diff --git a/man/man3/tomo-Num.asinh.3 b/man/man3/tomo-Num.asinh.3 index ed437b24..da88b719 100644 --- a/man/man3/tomo-Num.asinh.3 +++ b/man/man3/tomo-Num.asinh.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.asinh 3 2025-04-30 "Tomo man-pages" +.TH Num.asinh 3 2025-09-21 "Tomo man-pages" .SH NAME Num.asinh \- arc hyperbolic sine .SH LIBRARY @@ -29,6 +29,5 @@ The inverse hyperbolic sine of `x`. .SH EXAMPLES .EX ->> (0.0).asinh() -= 0 +assert (0.0).asinh() == 0 .EE diff --git a/man/man3/tomo-Num.atan.3 b/man/man3/tomo-Num.atan.3 index 116c70de..808338d4 100644 --- a/man/man3/tomo-Num.atan.3 +++ b/man/man3/tomo-Num.atan.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.atan 3 2025-04-30 "Tomo man-pages" +.TH Num.atan 3 2025-09-21 "Tomo man-pages" .SH NAME Num.atan \- arc tangent .SH LIBRARY @@ -29,6 +29,5 @@ The arc tangent of `x` in radians. .SH EXAMPLES .EX ->> (1.0).atan() // -> (π/4) -= 0.7854 +assert (1.0).atan() == 0.7854 .EE diff --git a/man/man3/tomo-Num.atan2.3 b/man/man3/tomo-Num.atan2.3 index 601047a1..ee2400aa 100644 --- a/man/man3/tomo-Num.atan2.3 +++ b/man/man3/tomo-Num.atan2.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.atan2 3 2025-04-30 "Tomo man-pages" +.TH Num.atan2 3 2025-09-21 "Tomo man-pages" .SH NAME Num.atan2 \- arc tangent from 2 variables .SH LIBRARY @@ -30,6 +30,5 @@ The arc tangent of `x/y` in radians. .SH EXAMPLES .EX ->> Num.atan2(1, 1) // -> (π/4) -= 0.7854 +assert Num.atan2(1, 1) == 0.7854 .EE diff --git a/man/man3/tomo-Num.atanh.3 b/man/man3/tomo-Num.atanh.3 index 43bfcc77..c7c30692 100644 --- a/man/man3/tomo-Num.atanh.3 +++ b/man/man3/tomo-Num.atanh.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.atanh 3 2025-04-30 "Tomo man-pages" +.TH Num.atanh 3 2025-09-21 "Tomo man-pages" .SH NAME Num.atanh \- arc hyperbolic tangent. .SH LIBRARY @@ -29,6 +29,5 @@ The inverse hyperbolic tangent of `x`. .SH EXAMPLES .EX ->> (0.5).atanh() -= 0.5493 +assert (0.5).atanh() == 0.5493 .EE diff --git a/man/man3/tomo-Num.cbrt.3 b/man/man3/tomo-Num.cbrt.3 index b74d2a15..15e0ee9e 100644 --- a/man/man3/tomo-Num.cbrt.3 +++ b/man/man3/tomo-Num.cbrt.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.cbrt 3 2025-04-30 "Tomo man-pages" +.TH Num.cbrt 3 2025-09-21 "Tomo man-pages" .SH NAME Num.cbrt \- cube root .SH LIBRARY @@ -29,6 +29,5 @@ The cube root of `x`. .SH EXAMPLES .EX ->> (27.0).cbrt() -= 3 +assert (27.0).cbrt() == 3 .EE diff --git a/man/man3/tomo-Num.ceil.3 b/man/man3/tomo-Num.ceil.3 index 639d7c3d..c0aac8a9 100644 --- a/man/man3/tomo-Num.ceil.3 +++ b/man/man3/tomo-Num.ceil.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.ceil 3 2025-04-30 "Tomo man-pages" +.TH Num.ceil 3 2025-09-21 "Tomo man-pages" .SH NAME Num.ceil \- ceiling function .SH LIBRARY @@ -29,6 +29,5 @@ The smallest integer greater than or equal to `x`. .SH EXAMPLES .EX ->> (3.2).ceil() -= 4 +assert (3.2).ceil() == 4 .EE diff --git a/man/man3/tomo-Num.clamped.3 b/man/man3/tomo-Num.clamped.3 index 01037d44..3ed48344 100644 --- a/man/man3/tomo-Num.clamped.3 +++ b/man/man3/tomo-Num.clamped.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.clamped 3 2025-04-30 "Tomo man-pages" +.TH Num.clamped 3 2025-09-21 "Tomo man-pages" .SH NAME Num.clamped \- clamp a number .SH LIBRARY @@ -31,6 +31,5 @@ The first argument clamped between the other two arguments. .SH EXAMPLES .EX ->> (2.5).clamped(5.5, 10.5) -= 5.5 +assert (2.5).clamped(5.5, 10.5) == 5.5 .EE diff --git a/man/man3/tomo-Num.copysign.3 b/man/man3/tomo-Num.copysign.3 index 1fd4d898..9230754c 100644 --- a/man/man3/tomo-Num.copysign.3 +++ b/man/man3/tomo-Num.copysign.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.copysign 3 2025-04-30 "Tomo man-pages" +.TH Num.copysign 3 2025-09-21 "Tomo man-pages" .SH NAME Num.copysign \- copy a number's sign .SH LIBRARY @@ -30,6 +30,5 @@ A number with the magnitude of `x` and the sign of `y`. .SH EXAMPLES .EX ->> (3.0).copysign(-1) -= -3 +assert (3.0).copysign(-1) == -3 .EE diff --git a/man/man3/tomo-Num.cos.3 b/man/man3/tomo-Num.cos.3 index ed1df601..6071c022 100644 --- a/man/man3/tomo-Num.cos.3 +++ b/man/man3/tomo-Num.cos.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.cos 3 2025-04-30 "Tomo man-pages" +.TH Num.cos 3 2025-09-21 "Tomo man-pages" .SH NAME Num.cos \- cosine .SH LIBRARY @@ -29,6 +29,5 @@ The cosine of `x`. .SH EXAMPLES .EX ->> (0.0).cos() -= 1 +assert (0.0).cos() == 1 .EE diff --git a/man/man3/tomo-Num.cosh.3 b/man/man3/tomo-Num.cosh.3 index 59ec417d..843ec369 100644 --- a/man/man3/tomo-Num.cosh.3 +++ b/man/man3/tomo-Num.cosh.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.cosh 3 2025-04-30 "Tomo man-pages" +.TH Num.cosh 3 2025-09-21 "Tomo man-pages" .SH NAME Num.cosh \- hyperbolic cosine .SH LIBRARY @@ -29,6 +29,5 @@ The hyperbolic cosine of `x`. .SH EXAMPLES .EX ->> (0.0).cosh() -= 1 +assert (0.0).cosh() == 1 .EE diff --git a/man/man3/tomo-Num.erf.3 b/man/man3/tomo-Num.erf.3 index 5f1a56f9..aec6194f 100644 --- a/man/man3/tomo-Num.erf.3 +++ b/man/man3/tomo-Num.erf.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.erf 3 2025-04-30 "Tomo man-pages" +.TH Num.erf 3 2025-09-21 "Tomo man-pages" .SH NAME Num.erf \- error function .SH LIBRARY @@ -29,6 +29,5 @@ The error function of `x`. .SH EXAMPLES .EX ->> (0.0).erf() -= 0 +assert (0.0).erf() == 0 .EE diff --git a/man/man3/tomo-Num.erfc.3 b/man/man3/tomo-Num.erfc.3 index cf0bcad7..27dcb44a 100644 --- a/man/man3/tomo-Num.erfc.3 +++ b/man/man3/tomo-Num.erfc.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.erfc 3 2025-04-30 "Tomo man-pages" +.TH Num.erfc 3 2025-09-21 "Tomo man-pages" .SH NAME Num.erfc \- complimentary error function .SH LIBRARY @@ -29,6 +29,5 @@ The complementary error function of `x`. .SH EXAMPLES .EX ->> (0.0).erfc() -= 1 +assert (0.0).erfc() == 1 .EE diff --git a/man/man3/tomo-Num.exp.3 b/man/man3/tomo-Num.exp.3 index e4ac0608..4778a76d 100644 --- a/man/man3/tomo-Num.exp.3 +++ b/man/man3/tomo-Num.exp.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.exp 3 2025-04-30 "Tomo man-pages" +.TH Num.exp 3 2025-09-21 "Tomo man-pages" .SH NAME Num.exp \- base-e exponentiation .SH LIBRARY @@ -29,6 +29,5 @@ The value of $e^x$. .SH EXAMPLES .EX ->> (1.0).exp() -= 2.7183 +assert (1.0).exp() == 2.7183 .EE diff --git a/man/man3/tomo-Num.exp2.3 b/man/man3/tomo-Num.exp2.3 index 4ac3e868..1d997802 100644 --- a/man/man3/tomo-Num.exp2.3 +++ b/man/man3/tomo-Num.exp2.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.exp2 3 2025-04-30 "Tomo man-pages" +.TH Num.exp2 3 2025-09-21 "Tomo man-pages" .SH NAME Num.exp2 \- base-2 exponentiation .SH LIBRARY @@ -29,6 +29,5 @@ The value of $2^x$. .SH EXAMPLES .EX ->> (3.0).exp2() -= 8 +assert (3.0).exp2() == 8 .EE diff --git a/man/man3/tomo-Num.expm1.3 b/man/man3/tomo-Num.expm1.3 index abec8bf1..956bb3ac 100644 --- a/man/man3/tomo-Num.expm1.3 +++ b/man/man3/tomo-Num.expm1.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.expm1 3 2025-04-30 "Tomo man-pages" +.TH Num.expm1 3 2025-09-21 "Tomo man-pages" .SH NAME Num.expm1 \- base-e exponential minus 1 .SH LIBRARY @@ -29,6 +29,5 @@ The value of $e^x - 1$. .SH EXAMPLES .EX ->> (1.0).expm1() -= 1.7183 +assert (1.0).expm1() == 1.7183 .EE diff --git a/man/man3/tomo-Num.fdim.3 b/man/man3/tomo-Num.fdim.3 index 32ece8ba..2498fc7b 100644 --- a/man/man3/tomo-Num.fdim.3 +++ b/man/man3/tomo-Num.fdim.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.fdim 3 2025-04-30 "Tomo man-pages" +.TH Num.fdim 3 2025-09-21 "Tomo man-pages" .SH NAME Num.fdim \- positive difference .SH LIBRARY @@ -32,6 +32,5 @@ The positive difference $\max(0, x - y)$. .EX fd ->> (5.0).fdim(3) -= 2 +assert (5.0).fdim(3) == 2 .EE diff --git a/man/man3/tomo-Num.floor.3 b/man/man3/tomo-Num.floor.3 index 63118259..2107a1f0 100644 --- a/man/man3/tomo-Num.floor.3 +++ b/man/man3/tomo-Num.floor.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.floor 3 2025-04-30 "Tomo man-pages" +.TH Num.floor 3 2025-09-21 "Tomo man-pages" .SH NAME Num.floor \- floor function .SH LIBRARY @@ -29,6 +29,5 @@ The largest integer less than or equal to `x`. .SH EXAMPLES .EX ->> (3.7).floor() -= 3 +assert (3.7).floor() == 3 .EE diff --git a/man/man3/tomo-Num.hypot.3 b/man/man3/tomo-Num.hypot.3 index c640236f..3c2e0913 100644 --- a/man/man3/tomo-Num.hypot.3 +++ b/man/man3/tomo-Num.hypot.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.hypot 3 2025-04-30 "Tomo man-pages" +.TH Num.hypot 3 2025-09-21 "Tomo man-pages" .SH NAME Num.hypot \- Euclidean distance function .SH LIBRARY @@ -30,6 +30,5 @@ The Euclidean norm of `x` and `y`. .SH EXAMPLES .EX ->> Num.hypot(3, 4) -= 5 +assert Num.hypot(3, 4) == 5 .EE diff --git a/man/man3/tomo-Num.is_between.3 b/man/man3/tomo-Num.is_between.3 index ae08f92a..7077b397 100644 --- a/man/man3/tomo-Num.is_between.3 +++ b/man/man3/tomo-Num.is_between.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.is_between 3 2025-04-30 "Tomo man-pages" +.TH Num.is_between 3 2025-09-21 "Tomo man-pages" .SH NAME Num.is_between \- check if a number is in a range .SH LIBRARY @@ -31,10 +31,7 @@ high Num The upper bound to check (inclusive). - .SH EXAMPLES .EX ->> (7.5).is_between(1, 10) -= yes ->> (7.5).is_between(100, 200) -= no ->> (7.5).is_between(1, 7.5) -= yes +assert (7.5).is_between(1, 10) == yes +assert (7.5).is_between(100, 200) == no +assert (7.5).is_between(1, 7.5) == yes .EE diff --git a/man/man3/tomo-Num.isfinite.3 b/man/man3/tomo-Num.isfinite.3 index 24a925ab..99fdd913 100644 --- a/man/man3/tomo-Num.isfinite.3 +++ b/man/man3/tomo-Num.isfinite.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.isfinite 3 2025-04-30 "Tomo man-pages" +.TH Num.isfinite 3 2025-09-21 "Tomo man-pages" .SH NAME Num.isfinite \- check for finite number .SH LIBRARY @@ -29,8 +29,6 @@ n Num The number to be checked. - .SH EXAMPLES .EX ->> (1.0).isfinite() -= yes ->> Num.INF.isfinite() -= no +assert (1.0).isfinite() == yes +assert Num.INF.isfinite() == no .EE diff --git a/man/man3/tomo-Num.isinf.3 b/man/man3/tomo-Num.isinf.3 index 9e0be863..f8587d7a 100644 --- a/man/man3/tomo-Num.isinf.3 +++ b/man/man3/tomo-Num.isinf.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.isinf 3 2025-04-30 "Tomo man-pages" +.TH Num.isinf 3 2025-09-21 "Tomo man-pages" .SH NAME Num.isinf \- check for infinite number .SH LIBRARY @@ -29,8 +29,6 @@ n Num The number to be checked. - .SH EXAMPLES .EX ->> Num.INF.isinf() -= yes ->> (1.0).isinf() -= no +assert Num.INF.isinf() == yes +assert (1.0).isinf() == no .EE diff --git a/man/man3/tomo-Num.j0.3 b/man/man3/tomo-Num.j0.3 index f2d7e0cb..1ad0ed38 100644 --- a/man/man3/tomo-Num.j0.3 +++ b/man/man3/tomo-Num.j0.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.j0 3 2025-04-30 "Tomo man-pages" +.TH Num.j0 3 2025-09-21 "Tomo man-pages" .SH NAME Num.j0 \- Bessel function .SH LIBRARY @@ -29,6 +29,5 @@ The Bessel function of the first kind of order 0 of `x`. .SH EXAMPLES .EX ->> (0.0).j0() -= 1 +assert (0.0).j0() == 1 .EE diff --git a/man/man3/tomo-Num.j1.3 b/man/man3/tomo-Num.j1.3 index 65d59793..7f3fda5a 100644 --- a/man/man3/tomo-Num.j1.3 +++ b/man/man3/tomo-Num.j1.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.j1 3 2025-04-30 "Tomo man-pages" +.TH Num.j1 3 2025-09-21 "Tomo man-pages" .SH NAME Num.j1 \- Bessel function .SH LIBRARY @@ -29,6 +29,5 @@ The Bessel function of the first kind of order 1 of `x`. .SH EXAMPLES .EX ->> (0.0).j1() -= 0 +assert (0.0).j1() == 0 .EE diff --git a/man/man3/tomo-Num.log.3 b/man/man3/tomo-Num.log.3 index de0a2d5c..5cfd660c 100644 --- a/man/man3/tomo-Num.log.3 +++ b/man/man3/tomo-Num.log.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.log 3 2025-04-30 "Tomo man-pages" +.TH Num.log 3 2025-09-21 "Tomo man-pages" .SH NAME Num.log \- natural logarithm .SH LIBRARY @@ -29,6 +29,5 @@ The natural logarithm of `x`. .SH EXAMPLES .EX ->> Num.E.log() -= 1 +assert Num.E.log() == 1 .EE diff --git a/man/man3/tomo-Num.log10.3 b/man/man3/tomo-Num.log10.3 index 24682774..87000cb9 100644 --- a/man/man3/tomo-Num.log10.3 +++ b/man/man3/tomo-Num.log10.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.log10 3 2025-04-30 "Tomo man-pages" +.TH Num.log10 3 2025-09-21 "Tomo man-pages" .SH NAME Num.log10 \- logarithm base-10 .SH LIBRARY @@ -29,6 +29,5 @@ The base-10 logarithm of `x`. .SH EXAMPLES .EX ->> (100.0).log10() -= 2 +assert (100.0).log10() == 2 .EE diff --git a/man/man3/tomo-Num.log1p.3 b/man/man3/tomo-Num.log1p.3 index 0fb715d7..dcf4a253 100644 --- a/man/man3/tomo-Num.log1p.3 +++ b/man/man3/tomo-Num.log1p.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.log1p 3 2025-04-30 "Tomo man-pages" +.TH Num.log1p 3 2025-09-21 "Tomo man-pages" .SH NAME Num.log1p \- logarithm of 1 plus x .SH LIBRARY @@ -29,6 +29,5 @@ The value of $\log(1 + x)$. .SH EXAMPLES .EX ->> (1.0).log1p() -= 0.6931 +assert (1.0).log1p() == 0.6931 .EE diff --git a/man/man3/tomo-Num.log2.3 b/man/man3/tomo-Num.log2.3 index 68820181..3e162d15 100644 --- a/man/man3/tomo-Num.log2.3 +++ b/man/man3/tomo-Num.log2.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.log2 3 2025-04-30 "Tomo man-pages" +.TH Num.log2 3 2025-09-21 "Tomo man-pages" .SH NAME Num.log2 \- logarithm base-2 .SH LIBRARY @@ -29,6 +29,5 @@ The base-2 logarithm of `x`. .SH EXAMPLES .EX ->> (8.0).log2() -= 3 +assert (8.0).log2() == 3 .EE diff --git a/man/man3/tomo-Num.logb.3 b/man/man3/tomo-Num.logb.3 index f7de8d87..519e6042 100644 --- a/man/man3/tomo-Num.logb.3 +++ b/man/man3/tomo-Num.logb.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.logb 3 2025-04-30 "Tomo man-pages" +.TH Num.logb 3 2025-09-21 "Tomo man-pages" .SH NAME Num.logb \- exponent of a floating point value .SH LIBRARY @@ -29,6 +29,5 @@ The binary exponent of `x`. .SH EXAMPLES .EX ->> (8.0).logb() -= 3 +assert (8.0).logb() == 3 .EE diff --git a/man/man3/tomo-Num.mix.3 b/man/man3/tomo-Num.mix.3 index a3a06b96..f06462eb 100644 --- a/man/man3/tomo-Num.mix.3 +++ b/man/man3/tomo-Num.mix.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.mix 3 2025-04-30 "Tomo man-pages" +.TH Num.mix 3 2025-09-21 "Tomo man-pages" .SH NAME Num.mix \- mix two numbers by an amount .SH LIBRARY @@ -31,8 +31,6 @@ The interpolated number between `x` and `y` based on `amount`. .SH EXAMPLES .EX ->> (0.5).mix(10, 20) -= 15 ->> (0.25).mix(10, 20) -= 12.5 +assert (0.5).mix(10, 20) == 15 +assert (0.25).mix(10, 20) == 12.5 .EE diff --git a/man/man3/tomo-Num.near.3 b/man/man3/tomo-Num.near.3 index 58ec4989..ef1b80ce 100644 --- a/man/man3/tomo-Num.near.3 +++ b/man/man3/tomo-Num.near.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.near 3 2025-04-30 "Tomo man-pages" +.TH Num.near 3 2025-09-21 "Tomo man-pages" .SH NAME Num.near \- check if two numbers are near each other .SH LIBRARY @@ -32,12 +32,7 @@ min_epsilon Num The absolute tolerance. Default is `1e-9`. 1e-9 .SH EXAMPLES .EX ->> (1.0).near(1.000000001) -= yes - ->> (100.0).near(110, ratio=0.1) -= yes - ->> (5.0).near(5.1, min_epsilon=0.1) -= yes +assert (1.0).near(1.000000001) == yes +assert (100.0).near(110, ratio=0.1) == yes +assert (5.0).near(5.1, min_epsilon=0.1) == yes .EE diff --git a/man/man3/tomo-Num.nextafter.3 b/man/man3/tomo-Num.nextafter.3 index b5b69948..1cc51818 100644 --- a/man/man3/tomo-Num.nextafter.3 +++ b/man/man3/tomo-Num.nextafter.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.nextafter 3 2025-04-30 "Tomo man-pages" +.TH Num.nextafter 3 2025-09-21 "Tomo man-pages" .SH NAME Num.nextafter \- next floating point number .SH LIBRARY @@ -30,6 +30,5 @@ The next representable value after `x` in the direction of `y`. .SH EXAMPLES .EX ->> (1.0).nextafter(1.1) -= 1.0000000000000002 +assert (1.0).nextafter(1.1) == 1.0000000000000002 .EE diff --git a/man/man3/tomo-Num.parse.3 b/man/man3/tomo-Num.parse.3 index 63165e59..d224e4e8 100644 --- a/man/man3/tomo-Num.parse.3 +++ b/man/man3/tomo-Num.parse.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.parse 3 2025-08-16 "Tomo man-pages" +.TH Num.parse 3 2025-09-21 "Tomo man-pages" .SH NAME Num.parse \- convert text to number .SH LIBRARY @@ -30,16 +30,10 @@ The number represented by the text or `none` if the entire text can't be parsed .SH EXAMPLES .EX ->> Num.parse("3.14") -= 3.14 : Num? ->> Num.parse("1e3") -= 1000 : Num? - ->> Num.parse("1.5junk") -= none : Num? +assert Num.parse("3.14") == 3.14 +assert Num.parse("1e3") == 1000 +assert Num.parse("1.5junk") == none remainder : Text ->> Num.parse("1.5junk", &remainder) -= 1.5 : Num? ->> remainder -= "junk" +assert Num.parse("1.5junk", &remainder) == 1.5 +assert remainder == "junk" .EE diff --git a/man/man3/tomo-Num.percent.3 b/man/man3/tomo-Num.percent.3 index 82b9f6b4..5c41845e 100644 --- a/man/man3/tomo-Num.percent.3 +++ b/man/man3/tomo-Num.percent.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.percent 3 2025-04-30 "Tomo man-pages" +.TH Num.percent 3 2025-09-21 "Tomo man-pages" .SH NAME Num.percent \- format as a percentage .SH LIBRARY @@ -30,12 +30,8 @@ A text representation of the number as a percentage with a percent sign. .SH EXAMPLES .EX ->> (0.5).percent() -= "50%" ->> (1./3.).percent(2) -= "33.33%" ->> (1./3.).percent(2, precision=0.0001) -= "33.3333%" ->> (1./3.).percent(2, precision=10.) -= "30%" +assert (0.5).percent() == "50%" +assert (1./3.).percent(2) == "33.33%" +assert (1./3.).percent(2, precision=0.0001) == "33.3333%" +assert (1./3.).percent(2, precision=10.) == "30%" .EE diff --git a/man/man3/tomo-Num.rint.3 b/man/man3/tomo-Num.rint.3 index 3a021eb1..ca1f9bfa 100644 --- a/man/man3/tomo-Num.rint.3 +++ b/man/man3/tomo-Num.rint.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.rint 3 2025-04-30 "Tomo man-pages" +.TH Num.rint 3 2025-09-21 "Tomo man-pages" .SH NAME Num.rint \- round to nearest integer .SH LIBRARY @@ -29,8 +29,6 @@ The nearest integer value of `x`. .SH EXAMPLES .EX ->> (3.5).rint() -= 4 ->> (2.5).rint() -= 2 +assert (3.5).rint() == 4 +assert (2.5).rint() == 2 .EE diff --git a/man/man3/tomo-Num.round.3 b/man/man3/tomo-Num.round.3 index 5cd46d6a..18075d34 100644 --- a/man/man3/tomo-Num.round.3 +++ b/man/man3/tomo-Num.round.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.round 3 2025-04-30 "Tomo man-pages" +.TH Num.round 3 2025-09-21 "Tomo man-pages" .SH NAME Num.round \- round to nearest integer .SH LIBRARY @@ -29,8 +29,6 @@ The nearest integer value of `x`. .SH EXAMPLES .EX ->> (2.3).round() -= 2 ->> (2.7).round() -= 3 +assert (2.3).round() == 2 +assert (2.7).round() == 3 .EE diff --git a/man/man3/tomo-Num.significand.3 b/man/man3/tomo-Num.significand.3 index 1349d08e..8cf9102c 100644 --- a/man/man3/tomo-Num.significand.3 +++ b/man/man3/tomo-Num.significand.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.significand 3 2025-04-30 "Tomo man-pages" +.TH Num.significand 3 2025-09-21 "Tomo man-pages" .SH NAME Num.significand \- get mantissa .SH LIBRARY @@ -29,6 +29,5 @@ The significand of `x`. .SH EXAMPLES .EX ->> (1234.567).significand() -= 0.1234567 +assert (1234.567).significand() == 0.1234567 .EE diff --git a/man/man3/tomo-Num.sin.3 b/man/man3/tomo-Num.sin.3 index f338741d..1d67353f 100644 --- a/man/man3/tomo-Num.sin.3 +++ b/man/man3/tomo-Num.sin.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.sin 3 2025-04-30 "Tomo man-pages" +.TH Num.sin 3 2025-09-21 "Tomo man-pages" .SH NAME Num.sin \- sine .SH LIBRARY @@ -29,6 +29,5 @@ The sine of `x`. .SH EXAMPLES .EX ->> (0.0).sin() -= 0 +assert (0.0).sin() == 0 .EE diff --git a/man/man3/tomo-Num.sinh.3 b/man/man3/tomo-Num.sinh.3 index 42ed5158..c154356f 100644 --- a/man/man3/tomo-Num.sinh.3 +++ b/man/man3/tomo-Num.sinh.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.sinh 3 2025-04-30 "Tomo man-pages" +.TH Num.sinh 3 2025-09-21 "Tomo man-pages" .SH NAME Num.sinh \- hyperbolic sine .SH LIBRARY @@ -29,6 +29,5 @@ The hyperbolic sine of `x`. .SH EXAMPLES .EX ->> (0.0).sinh() -= 0 +assert (0.0).sinh() == 0 .EE diff --git a/man/man3/tomo-Num.sqrt.3 b/man/man3/tomo-Num.sqrt.3 index 64784753..82cba25e 100644 --- a/man/man3/tomo-Num.sqrt.3 +++ b/man/man3/tomo-Num.sqrt.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.sqrt 3 2025-04-30 "Tomo man-pages" +.TH Num.sqrt 3 2025-09-21 "Tomo man-pages" .SH NAME Num.sqrt \- square root .SH LIBRARY @@ -29,6 +29,5 @@ The square root of `x`. .SH EXAMPLES .EX ->> (16.0).sqrt() -= 4 +assert (16.0).sqrt() == 4 .EE diff --git a/man/man3/tomo-Num.tan.3 b/man/man3/tomo-Num.tan.3 index 3c780247..3e66ebb7 100644 --- a/man/man3/tomo-Num.tan.3 +++ b/man/man3/tomo-Num.tan.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.tan 3 2025-04-30 "Tomo man-pages" +.TH Num.tan 3 2025-09-21 "Tomo man-pages" .SH NAME Num.tan \- tangent .SH LIBRARY @@ -29,6 +29,5 @@ The tangent of `x`. .SH EXAMPLES .EX ->> (0.0).tan() -= 0 +assert (0.0).tan() == 0 .EE diff --git a/man/man3/tomo-Num.tanh.3 b/man/man3/tomo-Num.tanh.3 index e9814b22..86c97449 100644 --- a/man/man3/tomo-Num.tanh.3 +++ b/man/man3/tomo-Num.tanh.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.tanh 3 2025-04-30 "Tomo man-pages" +.TH Num.tanh 3 2025-09-21 "Tomo man-pages" .SH NAME Num.tanh \- hyperbolic tangent .SH LIBRARY @@ -29,6 +29,5 @@ The hyperbolic tangent of `x`. .SH EXAMPLES .EX ->> (0.0).tanh() -= 0 +assert (0.0).tanh() == 0 .EE diff --git a/man/man3/tomo-Num.tgamma.3 b/man/man3/tomo-Num.tgamma.3 index e5f450a8..c2cfb0f1 100644 --- a/man/man3/tomo-Num.tgamma.3 +++ b/man/man3/tomo-Num.tgamma.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.tgamma 3 2025-04-30 "Tomo man-pages" +.TH Num.tgamma 3 2025-09-21 "Tomo man-pages" .SH NAME Num.tgamma \- true gamma function .SH LIBRARY @@ -29,6 +29,5 @@ The gamma function of `x`. .SH EXAMPLES .EX ->> (1.0).tgamma() -= 1 +assert (1.0).tgamma() == 1 .EE diff --git a/man/man3/tomo-Num.trunc.3 b/man/man3/tomo-Num.trunc.3 index 9d1c9e1e..e32b0949 100644 --- a/man/man3/tomo-Num.trunc.3 +++ b/man/man3/tomo-Num.trunc.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.trunc 3 2025-04-30 "Tomo man-pages" +.TH Num.trunc 3 2025-09-21 "Tomo man-pages" .SH NAME Num.trunc \- truncate a number .SH LIBRARY @@ -29,8 +29,6 @@ The integer part of `x` towards zero. .SH EXAMPLES .EX ->> (3.7).trunc() -= 3 ->> (-3.7).trunc() -= -3 +assert (3.7).trunc() == 3 +assert (-3.7).trunc() == -3 .EE diff --git a/man/man3/tomo-Num.with_precision.3 b/man/man3/tomo-Num.with_precision.3 index 6dabcc0c..66b5c0e9 100644 --- a/man/man3/tomo-Num.with_precision.3 +++ b/man/man3/tomo-Num.with_precision.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.with_precision 3 2025-04-30 "Tomo man-pages" +.TH Num.with_precision 3 2025-09-21 "Tomo man-pages" .SH NAME Num.with_precision \- round to a given precision .SH LIBRARY @@ -30,10 +30,7 @@ The number, rounded to the given precision level. .SH EXAMPLES .EX ->> (0.1234567).with_precision(0.01) -= 0.12 ->> (123456.).with_precision(100) -= 123500 ->> (1234567.).with_precision(5) -= 1234565 +assert (0.1234567).with_precision(0.01) == 0.12 +assert (123456.).with_precision(100) == 123500 +assert (1234567.).with_precision(5) == 1234565 .EE diff --git a/man/man3/tomo-Num.y0.3 b/man/man3/tomo-Num.y0.3 index d97523d1..0645c252 100644 --- a/man/man3/tomo-Num.y0.3 +++ b/man/man3/tomo-Num.y0.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.y0 3 2025-04-30 "Tomo man-pages" +.TH Num.y0 3 2025-09-21 "Tomo man-pages" .SH NAME Num.y0 \- Bessel function .SH LIBRARY @@ -29,6 +29,5 @@ The Bessel function of the second kind of order 0 of `x`. .SH EXAMPLES .EX ->> (1.0).y0() -= -0.7652 +assert (1.0).y0() == -0.7652 .EE diff --git a/man/man3/tomo-Num.y1.3 b/man/man3/tomo-Num.y1.3 index 8f4a8b59..ef572874 100644 --- a/man/man3/tomo-Num.y1.3 +++ b/man/man3/tomo-Num.y1.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Num.y1 3 2025-04-30 "Tomo man-pages" +.TH Num.y1 3 2025-09-21 "Tomo man-pages" .SH NAME Num.y1 \- Bessel function .SH LIBRARY @@ -29,6 +29,5 @@ The Bessel function of the second kind of order 1 of `x`. .SH EXAMPLES .EX ->> (1.0).y1() -= 0.4401 +assert (1.0).y1() == 0.4401 .EE diff --git a/man/man3/tomo-Path.accessed.3 b/man/man3/tomo-Path.accessed.3 index a3b123e8..51e4bbed 100644 --- a/man/man3/tomo-Path.accessed.3 +++ b/man/man3/tomo-Path.accessed.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.accessed 3 2025-05-17 "Tomo man-pages" +.TH Path.accessed 3 2025-09-21 "Tomo man-pages" .SH NAME Path.accessed \- access time .SH LIBRARY @@ -30,8 +30,6 @@ A 64-bit unix epoch timestamp representing when the file or directory was last a .SH EXAMPLES .EX ->> (./file.txt).accessed() -= 1704221100? ->> (./not-a-file).accessed() -= none +assert (./file.txt).accessed() == 1704221100 +assert (./not-a-file).accessed() == none .EE diff --git a/man/man3/tomo-Path.base_name.3 b/man/man3/tomo-Path.base_name.3 index 61ab427f..fe43fc04 100644 --- a/man/man3/tomo-Path.base_name.3 +++ b/man/man3/tomo-Path.base_name.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.base_name 3 2025-05-17 "Tomo man-pages" +.TH Path.base_name 3 2025-09-21 "Tomo man-pages" .SH NAME Path.base_name \- base name of a file .SH LIBRARY @@ -29,6 +29,5 @@ The base name of the file or directory. .SH EXAMPLES .EX ->> (./path/to/file.txt).base_name() -= "file.txt" +assert (./path/to/file.txt).base_name() == "file.txt" .EE diff --git a/man/man3/tomo-Path.can_execute.3 b/man/man3/tomo-Path.can_execute.3 index 8ede21d2..7f9ed358 100644 --- a/man/man3/tomo-Path.can_execute.3 +++ b/man/man3/tomo-Path.can_execute.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.can_execute 3 2025-05-17 "Tomo man-pages" +.TH Path.can_execute 3 2025-09-21 "Tomo man-pages" .SH NAME Path.can_execute \- check execute permissions .SH LIBRARY @@ -29,10 +29,7 @@ path Path The path of the file to check. - .SH EXAMPLES .EX ->> (/bin/sh).can_execute() -= yes ->> (/usr/include/stdlib.h).can_execute() -= no ->> (/non/existant/file).can_execute() -= no +assert (/bin/sh).can_execute() == yes +assert (/usr/include/stdlib.h).can_execute() == no +assert (/non/existant/file).can_execute() == no .EE diff --git a/man/man3/tomo-Path.can_read.3 b/man/man3/tomo-Path.can_read.3 index 2848fef2..30cb39a0 100644 --- a/man/man3/tomo-Path.can_read.3 +++ b/man/man3/tomo-Path.can_read.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.can_read 3 2025-05-17 "Tomo man-pages" +.TH Path.can_read 3 2025-09-21 "Tomo man-pages" .SH NAME Path.can_read \- check read permissions .SH LIBRARY @@ -29,10 +29,7 @@ path Path The path of the file to check. - .SH EXAMPLES .EX ->> (/usr/include/stdlib.h).can_read() -= yes ->> (/etc/shadow).can_read() -= no ->> (/non/existant/file).can_read() -= no +assert (/usr/include/stdlib.h).can_read() == yes +assert (/etc/shadow).can_read() == no +assert (/non/existant/file).can_read() == no .EE diff --git a/man/man3/tomo-Path.can_write.3 b/man/man3/tomo-Path.can_write.3 index 51c4527b..d1be5006 100644 --- a/man/man3/tomo-Path.can_write.3 +++ b/man/man3/tomo-Path.can_write.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.can_write 3 2025-05-17 "Tomo man-pages" +.TH Path.can_write 3 2025-09-21 "Tomo man-pages" .SH NAME Path.can_write \- check write permissions .SH LIBRARY @@ -29,10 +29,7 @@ path Path The path of the file to check. - .SH EXAMPLES .EX ->> (/tmp).can_write() -= yes ->> (/etc/passwd).can_write() -= no ->> (/non/existant/file).can_write() -= no +assert (/tmp).can_write() == yes +assert (/etc/passwd).can_write() == no +assert (/non/existant/file).can_write() == no .EE diff --git a/man/man3/tomo-Path.changed.3 b/man/man3/tomo-Path.changed.3 index 21e487b1..b6bd8033 100644 --- a/man/man3/tomo-Path.changed.3 +++ b/man/man3/tomo-Path.changed.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.changed 3 2025-05-17 "Tomo man-pages" +.TH Path.changed 3 2025-09-21 "Tomo man-pages" .SH NAME Path.changed \- get the last changed time .SH LIBRARY @@ -33,8 +33,6 @@ This is the ["ctime"](https://en.wikipedia.org/wiki/Stat_(system_call)#ctime) of .SH EXAMPLES .EX ->> (./file.txt).changed() -= 1704221100? ->> (./not-a-file).changed() -= none +assert (./file.txt).changed() == 1704221100 +assert (./not-a-file).changed() == none .EE diff --git a/man/man3/tomo-Path.child.3 b/man/man3/tomo-Path.child.3 index c1d9b27b..f61bc9d0 100644 --- a/man/man3/tomo-Path.child.3 +++ b/man/man3/tomo-Path.child.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.child 3 2025-05-17 "Tomo man-pages" +.TH Path.child 3 2025-09-21 "Tomo man-pages" .SH NAME Path.child \- append a child to a path .SH LIBRARY @@ -30,6 +30,5 @@ A new path representing the child. .SH EXAMPLES .EX ->> (./directory).child("file.txt") -= (./directory/file.txt) +assert (./directory).child("file.txt") == (./directory/file.txt) .EE diff --git a/man/man3/tomo-Path.children.3 b/man/man3/tomo-Path.children.3 index 8b5168a6..10e80713 100644 --- a/man/man3/tomo-Path.children.3 +++ b/man/man3/tomo-Path.children.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.children 3 2025-05-17 "Tomo man-pages" +.TH Path.children 3 2025-09-21 "Tomo man-pages" .SH NAME Path.children \- get children of a directory .SH LIBRARY @@ -30,6 +30,5 @@ A list of paths for the children. .SH EXAMPLES .EX ->> (./directory).children(include_hidden=yes) -= [".git", "foo.txt"] +assert (./directory).children(include_hidden=yes) == [".git", "foo.txt"] .EE diff --git a/man/man3/tomo-Path.current_dir.3 b/man/man3/tomo-Path.current_dir.3 index f15439de..2d887983 100644 --- a/man/man3/tomo-Path.current_dir.3 +++ b/man/man3/tomo-Path.current_dir.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.current_dir 3 2025-05-17 "Tomo man-pages" +.TH Path.current_dir 3 2025-09-21 "Tomo man-pages" .SH NAME Path.current_dir \- get current directory .SH LIBRARY @@ -20,6 +20,5 @@ The absolute path of the current directory. .SH EXAMPLES .EX ->> Path.current_dir() -= (/home/user/tomo) +assert Path.current_dir() == (/home/user/tomo) .EE diff --git a/man/man3/tomo-Path.exists.3 b/man/man3/tomo-Path.exists.3 index 3ac63a15..923fa27d 100644 --- a/man/man3/tomo-Path.exists.3 +++ b/man/man3/tomo-Path.exists.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.exists 3 2025-05-17 "Tomo man-pages" +.TH Path.exists 3 2025-09-21 "Tomo man-pages" .SH NAME Path.exists \- check if a path exists .SH LIBRARY @@ -29,6 +29,5 @@ path Path The path to check. - .SH EXAMPLES .EX ->> (/).exists() -= yes +assert (/).exists() == yes .EE diff --git a/man/man3/tomo-Path.extension.3 b/man/man3/tomo-Path.extension.3 index 08d348c8..f77f692a 100644 --- a/man/man3/tomo-Path.extension.3 +++ b/man/man3/tomo-Path.extension.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.extension 3 2025-05-17 "Tomo man-pages" +.TH Path.extension 3 2025-09-21 "Tomo man-pages" .SH NAME Path.extension \- get file extension .SH LIBRARY @@ -30,12 +30,8 @@ The file extension (not including the leading `.`) or an empty text if there is .SH EXAMPLES .EX ->> (./file.tar.gz).extension() -= "tar.gz" ->> (./file.tar.gz).extension(full=no) -= "gz" ->> (/foo).extension() -= "" ->> (./.git).extension() -= "" +assert (./file.tar.gz).extension() == "tar.gz" +assert (./file.tar.gz).extension(full=no) == "gz" +assert (/foo).extension() == "" +assert (./.git).extension() == "" .EE diff --git a/man/man3/tomo-Path.files.3 b/man/man3/tomo-Path.files.3 index 74b2168b..fcde934f 100644 --- a/man/man3/tomo-Path.files.3 +++ b/man/man3/tomo-Path.files.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.files 3 2025-05-17 "Tomo man-pages" +.TH Path.files 3 2025-09-21 "Tomo man-pages" .SH NAME Path.files \- list files in a directory .SH LIBRARY @@ -30,6 +30,5 @@ A list of file paths. .SH EXAMPLES .EX ->> (./directory).files(include_hidden=yes) -= [(./directory/file1.txt), (./directory/file2.txt)] +assert (./directory).files(include_hidden=yes) == [(./directory/file1.txt), (./directory/file2.txt)] .EE diff --git a/man/man3/tomo-Path.from_components.3 b/man/man3/tomo-Path.from_components.3 index 8fe4929f..f7dbd7f1 100644 --- a/man/man3/tomo-Path.from_components.3 +++ b/man/man3/tomo-Path.from_components.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.from_components 3 2025-05-17 "Tomo man-pages" +.TH Path.from_components 3 2025-09-21 "Tomo man-pages" .SH NAME Path.from_components \- build a path from components .SH LIBRARY @@ -29,10 +29,7 @@ A path representing the given components. .SH EXAMPLES .EX ->> Path.from_components(["/", "usr", "include"]) -= /usr/include ->> Path.from_components(["foo.txt"]) -= ./foo.txt ->> Path.from_components(["~", ".local"]) -= ~/.local +assert Path.from_components(["/", "usr", "include"]) == (/usr/include) +assert Path.from_components(["foo.txt"]) == (./foo.txt) +assert Path.from_components(["~", ".local"]) == (~/.local) .EE diff --git a/man/man3/tomo-Path.glob.3 b/man/man3/tomo-Path.glob.3 index 6d857322..07de7a33 100644 --- a/man/man3/tomo-Path.glob.3 +++ b/man/man3/tomo-Path.glob.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.glob 3 2025-05-17 "Tomo man-pages" +.TH Path.glob 3 2025-09-21 "Tomo man-pages" .SH NAME Path.glob \- perform file globbing .SH LIBRARY @@ -36,19 +36,11 @@ A list of file paths that match the glob. .SH EXAMPLES .EX # Current directory includes: foo.txt, baz.txt, qux.jpg, .hidden ->> (./*).glob() -= [(./foo.txt), (./baz.txt), (./qux.jpg)] - ->> (./*.txt).glob() -= [(./foo.txt), (./baz.txt)] - ->> (./*.{txt,jpg}).glob() -= [(./foo.txt), (./baz.txt), (./qux.jpg)] - ->> (./.*).glob() -= [(./.hidden)] +assert (./*).glob() == [(./foo.txt), (./baz.txt), (./qux.jpg)] +assert (./*.txt).glob() == [(./foo.txt), (./baz.txt)] +assert (./*.{txt,jpg}).glob() == [(./foo.txt), (./baz.txt), (./qux.jpg)] +assert (./.*).glob() == [(./.hidden)] # Globs with no matches return an empty list: ->> (./*.xxx).glob() -= [] +assert (./*.xxx).glob() == [] .EE diff --git a/man/man3/tomo-Path.group.3 b/man/man3/tomo-Path.group.3 index bb49b4f3..5c9f80c8 100644 --- a/man/man3/tomo-Path.group.3 +++ b/man/man3/tomo-Path.group.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.group 3 2025-05-17 "Tomo man-pages" +.TH Path.group 3 2025-09-21 "Tomo man-pages" .SH NAME Path.group \- get the owning group .SH LIBRARY @@ -30,8 +30,6 @@ The name of the group which owns the file or directory, or `none` if the path do .SH EXAMPLES .EX ->> (/bin).group() -= "root" ->> (/non/existent/file).group() -= none +assert (/bin).group() == "root" +assert (/non/existent/file).group() == none .EE diff --git a/man/man3/tomo-Path.has_extension.3 b/man/man3/tomo-Path.has_extension.3 index 4556c819..ffd1f967 100644 --- a/man/man3/tomo-Path.has_extension.3 +++ b/man/man3/tomo-Path.has_extension.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.has_extension 3 2025-06-24 "Tomo man-pages" +.TH Path.has_extension 3 2025-09-21 "Tomo man-pages" .SH NAME Path.has_extension \- check if a path has a given extension .SH LIBRARY @@ -30,12 +30,8 @@ Whether or not the path has the given extension. .SH EXAMPLES .EX ->> (/foo.txt).has_extension("txt") -= yes ->> (/foo.txt).has_extension(".txt") -= yes ->> (/foo.tar.gz).has_extension("gz") -= yes ->> (/foo.tar.gz).has_extension("zip") -= no +assert (/foo.txt).has_extension("txt") == yes +assert (/foo.txt).has_extension(".txt") == yes +assert (/foo.tar.gz).has_extension("gz") == yes +assert (/foo.tar.gz).has_extension("zip") == no .EE diff --git a/man/man3/tomo-Path.is_directory.3 b/man/man3/tomo-Path.is_directory.3 index 5b098b98..8ed41249 100644 --- a/man/man3/tomo-Path.is_directory.3 +++ b/man/man3/tomo-Path.is_directory.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.is_directory 3 2025-05-17 "Tomo man-pages" +.TH Path.is_directory 3 2025-09-21 "Tomo man-pages" .SH NAME Path.is_directory \- check if a path is a directory .SH LIBRARY @@ -30,9 +30,6 @@ follow_symlinks Whether to follow symbolic links. yes .SH EXAMPLES .EX ->> (./directory/).is_directory() -= yes - ->> (./file.txt).is_directory() -= no +assert (./directory/).is_directory() == yes +assert (./file.txt).is_directory() == no .EE diff --git a/man/man3/tomo-Path.is_file.3 b/man/man3/tomo-Path.is_file.3 index b5d3b8f2..8d6218f3 100644 --- a/man/man3/tomo-Path.is_file.3 +++ b/man/man3/tomo-Path.is_file.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.is_file 3 2025-05-17 "Tomo man-pages" +.TH Path.is_file 3 2025-09-21 "Tomo man-pages" .SH NAME Path.is_file \- check if a path is a file .SH LIBRARY @@ -30,9 +30,6 @@ follow_symlinks Whether to follow symbolic links. yes .SH EXAMPLES .EX ->> (./file.txt).is_file() -= yes - ->> (./directory/).is_file() -= no +assert (./file.txt).is_file() == yes +assert (./directory/).is_file() == no .EE diff --git a/man/man3/tomo-Path.is_socket.3 b/man/man3/tomo-Path.is_socket.3 index 1565cc92..1733364e 100644 --- a/man/man3/tomo-Path.is_socket.3 +++ b/man/man3/tomo-Path.is_socket.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.is_socket 3 2025-05-17 "Tomo man-pages" +.TH Path.is_socket 3 2025-09-21 "Tomo man-pages" .SH NAME Path.is_socket \- check if a path is a socket .SH LIBRARY @@ -30,6 +30,5 @@ follow_symlinks Whether to follow symbolic links. yes .SH EXAMPLES .EX ->> (./socket).is_socket() -= yes +assert (./socket).is_socket() == yes .EE diff --git a/man/man3/tomo-Path.is_symlink.3 b/man/man3/tomo-Path.is_symlink.3 index a09ea8c8..6a8bdb7e 100644 --- a/man/man3/tomo-Path.is_symlink.3 +++ b/man/man3/tomo-Path.is_symlink.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.is_symlink 3 2025-05-17 "Tomo man-pages" +.TH Path.is_symlink 3 2025-09-21 "Tomo man-pages" .SH NAME Path.is_symlink \- check if a path is a symbolic link .SH LIBRARY @@ -29,6 +29,5 @@ path Path The path to check. - .SH EXAMPLES .EX ->> (./link).is_symlink() -= yes +assert (./link).is_symlink() == yes .EE diff --git a/man/man3/tomo-Path.modified.3 b/man/man3/tomo-Path.modified.3 index 61d7d064..c91aae03 100644 --- a/man/man3/tomo-Path.modified.3 +++ b/man/man3/tomo-Path.modified.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.modified 3 2025-05-17 "Tomo man-pages" +.TH Path.modified 3 2025-09-21 "Tomo man-pages" .SH NAME Path.modified \- get file modification time .SH LIBRARY @@ -30,8 +30,6 @@ A 64-bit unix epoch timestamp representing when the file or directory was last m .SH EXAMPLES .EX ->> (./file.txt).modified() -= 1704221100? ->> (./not-a-file).modified() -= none +assert (./file.txt).modified() == 1704221100 +assert (./not-a-file).modified() == none .EE diff --git a/man/man3/tomo-Path.owner.3 b/man/man3/tomo-Path.owner.3 index af9e40e7..2f4913cd 100644 --- a/man/man3/tomo-Path.owner.3 +++ b/man/man3/tomo-Path.owner.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.owner 3 2025-05-17 "Tomo man-pages" +.TH Path.owner 3 2025-09-21 "Tomo man-pages" .SH NAME Path.owner \- get file owner .SH LIBRARY @@ -30,8 +30,6 @@ The name of the user who owns the file or directory, or `none` if the path does .SH EXAMPLES .EX ->> (/bin).owner() -= "root" ->> (/non/existent/file).owner() -= none +assert (/bin).owner() == "root" +assert (/non/existent/file).owner() == none .EE diff --git a/man/man3/tomo-Path.parent.3 b/man/man3/tomo-Path.parent.3 index 03528c2c..459d97c3 100644 --- a/man/man3/tomo-Path.parent.3 +++ b/man/man3/tomo-Path.parent.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.parent 3 2025-05-17 "Tomo man-pages" +.TH Path.parent 3 2025-09-21 "Tomo man-pages" .SH NAME Path.parent \- get parent directory .SH LIBRARY @@ -29,6 +29,5 @@ The path of the parent directory. .SH EXAMPLES .EX ->> (./path/to/file.txt).parent() -= (./path/to/) +assert (./path/to/file.txt).parent() == (./path/to/) .EE diff --git a/man/man3/tomo-Path.read.3 b/man/man3/tomo-Path.read.3 index b3c4ba44..779bb397 100644 --- a/man/man3/tomo-Path.read.3 +++ b/man/man3/tomo-Path.read.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.read 3 2025-05-17 "Tomo man-pages" +.TH Path.read 3 2025-09-21 "Tomo man-pages" .SH NAME Path.read \- read file contents .SH LIBRARY @@ -29,9 +29,6 @@ The contents of the file. If the file could not be read, none will be returned. .SH EXAMPLES .EX ->> (./hello.txt).read() -= "Hello"? - ->> (./nosuchfile.xxx).read() -= none +assert (./hello.txt).read() == "Hello" +assert (./nosuchfile.xxx).read() == none .EE diff --git a/man/man3/tomo-Path.read_bytes.3 b/man/man3/tomo-Path.read_bytes.3 index 22604598..a23cbf6d 100644 --- a/man/man3/tomo-Path.read_bytes.3 +++ b/man/man3/tomo-Path.read_bytes.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.read_bytes 3 2025-05-17 "Tomo man-pages" +.TH Path.read_bytes 3 2025-09-21 "Tomo man-pages" .SH NAME Path.read_bytes \- read file contents as bytes .SH LIBRARY @@ -30,9 +30,6 @@ The byte contents of the file. If the file cannot be read, none will be returned .SH EXAMPLES .EX ->> (./hello.txt).read() -= [72, 101, 108, 108, 111]? - ->> (./nosuchfile.xxx).read() -= none +assert (./hello.txt).read() == [72, 101, 108, 108, 111] +assert (./nosuchfile.xxx).read() == none .EE diff --git a/man/man3/tomo-Path.relative_to.3 b/man/man3/tomo-Path.relative_to.3 index 5225870b..963b9a5b 100644 --- a/man/man3/tomo-Path.relative_to.3 +++ b/man/man3/tomo-Path.relative_to.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.relative_to 3 2025-05-17 "Tomo man-pages" +.TH Path.relative_to 3 2025-09-21 "Tomo man-pages" .SH NAME Path.relative_to \- apply a relative path to another .SH LIBRARY @@ -30,6 +30,5 @@ The relative path. .SH EXAMPLES .EX ->> (./path/to/file.txt).relative(relative_to=(./path)) -= (./to/file.txt) +assert (./path/to/file.txt).relative(relative_to=(./path)) == (./to/file.txt) .EE diff --git a/man/man3/tomo-Path.resolved.3 b/man/man3/tomo-Path.resolved.3 index e2479595..a40fd80c 100644 --- a/man/man3/tomo-Path.resolved.3 +++ b/man/man3/tomo-Path.resolved.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.resolved 3 2025-05-17 "Tomo man-pages" +.TH Path.resolved 3 2025-09-21 "Tomo man-pages" .SH NAME Path.resolved \- resolve a path .SH LIBRARY @@ -30,9 +30,6 @@ The resolved absolute path. .SH EXAMPLES .EX ->> (~/foo).resolved() -= (/home/user/foo) - ->> (./path/to/file.txt).resolved(relative_to=(/foo)) -= (/foo/path/to/file.txt) +assert (~/foo).resolved() == (/home/user/foo) +assert (./path/to/file.txt).resolved(relative_to=(/foo)) == (/foo/path/to/file.txt) .EE diff --git a/man/man3/tomo-Path.sibling.3 b/man/man3/tomo-Path.sibling.3 index 5cd1afa1..5c39d159 100644 --- a/man/man3/tomo-Path.sibling.3 +++ b/man/man3/tomo-Path.sibling.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.sibling 3 2025-05-17 "Tomo man-pages" +.TH Path.sibling 3 2025-09-21 "Tomo man-pages" .SH NAME Path.sibling \- get another path in the same directory .SH LIBRARY @@ -30,6 +30,5 @@ A new path representing the sibling. .SH EXAMPLES .EX ->> (/foo/baz).sibling("doop") -= (/foo/doop) +assert (/foo/baz).sibling("doop") == (/foo/doop) .EE diff --git a/man/man3/tomo-Path.subdirectories.3 b/man/man3/tomo-Path.subdirectories.3 index 1ac0e258..a691f94a 100644 --- a/man/man3/tomo-Path.subdirectories.3 +++ b/man/man3/tomo-Path.subdirectories.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.subdirectories 3 2025-05-17 "Tomo man-pages" +.TH Path.subdirectories 3 2025-09-21 "Tomo man-pages" .SH NAME Path.subdirectories \- get subdirectories .SH LIBRARY @@ -30,9 +30,6 @@ A list of subdirectory paths. .SH EXAMPLES .EX ->> (./directory).subdirectories() -= [(./directory/subdir1), (./directory/subdir2)] - ->> (./directory).subdirectories(include_hidden=yes) -= [(./directory/.git), (./directory/subdir1), (./directory/subdir2)] +assert (./directory).subdirectories() == [(./directory/subdir1), (./directory/subdir2)] +assert (./directory).subdirectories(include_hidden=yes) == [(./directory/.git), (./directory/subdir1), (./directory/subdir2)] .EE diff --git a/man/man3/tomo-Path.unique_directory.3 b/man/man3/tomo-Path.unique_directory.3 index 02b4b7e7..866ca565 100644 --- a/man/man3/tomo-Path.unique_directory.3 +++ b/man/man3/tomo-Path.unique_directory.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.unique_directory 3 2025-05-17 "Tomo man-pages" +.TH Path.unique_directory 3 2025-09-21 "Tomo man-pages" .SH NAME Path.unique_directory \- create a directory with a unique name .SH LIBRARY @@ -29,9 +29,7 @@ A unique directory path after creating the directory. .SH EXAMPLES .EX ->> created := (/tmp/my-dir.XXXXXX).unique_directory() -= (/tmp/my-dir-AwoxbM/) ->> created.is_directory() -= yes +assert created := (/tmp/my-dir.XXXXXX).unique_directory() == (/tmp/my-dir-AwoxbM/) +assert created.is_directory() == yes created.remove() .EE diff --git a/man/man3/tomo-Path.write_unique.3 b/man/man3/tomo-Path.write_unique.3 index 27ac6341..94f3cd6f 100644 --- a/man/man3/tomo-Path.write_unique.3 +++ b/man/man3/tomo-Path.write_unique.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.write_unique 3 2025-05-17 "Tomo man-pages" +.TH Path.write_unique 3 2025-09-21 "Tomo man-pages" .SH NAME Path.write_unique \- write to a uniquely named file .SH LIBRARY @@ -30,9 +30,8 @@ The path of the newly created unique file. .SH EXAMPLES .EX ->> created := (./file-XXXXXX.txt).write_unique("Hello, world!") -= (./file-27QHtq.txt) ->> created.read() -= "Hello, world!" +created := (./file-XXXXXX.txt).write_unique("Hello, world!") +assert created == (./file-27QHtq.txt) +assert created.read() == "Hello, world!" created.remove() .EE diff --git a/man/man3/tomo-Path.write_unique_bytes.3 b/man/man3/tomo-Path.write_unique_bytes.3 index 077dc44a..f4a82e63 100644 --- a/man/man3/tomo-Path.write_unique_bytes.3 +++ b/man/man3/tomo-Path.write_unique_bytes.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Path.write_unique_bytes 3 2025-05-17 "Tomo man-pages" +.TH Path.write_unique_bytes 3 2025-09-21 "Tomo man-pages" .SH NAME Path.write_unique_bytes \- write bytes to a uniquely named file .SH LIBRARY @@ -30,9 +30,8 @@ The path of the newly created unique file. .SH EXAMPLES .EX ->> created := (./file-XXXXXX.txt).write_unique_bytes([1, 2, 3]) -= (./file-27QHtq.txt) ->> created.read() -= [1, 2, 3] +created := (./file-XXXXXX.txt).write_unique_bytes([1, 2, 3]) +assert created == (./file-27QHtq.txt) +assert created.read() == [1, 2, 3] created.remove() .EE diff --git a/man/man3/tomo-Table.clear.3 b/man/man3/tomo-Table.clear.3 index c7eeb8bd..5b1be29e 100644 --- a/man/man3/tomo-Table.clear.3 +++ b/man/man3/tomo-Table.clear.3 @@ -2,14 +2,14 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Table.clear 3 2025-05-17 "Tomo man-pages" +.TH Table.clear 3 2025-09-21 "Tomo man-pages" .SH NAME Table.clear \- clear a table .SH LIBRARY Tomo Standard Library .SH SYNOPSIS .nf -.BI Table.clear\ :\ func(t:\ &{K=V}\ ->\ Void) +.BI Table.clear\ :\ func(t:\ &{K:V}\ ->\ Void) .fi .SH DESCRIPTION Removes all key-value pairs from the table. @@ -22,12 +22,14 @@ allbox; lb lb lbx lb l l l l. Name Type Description Default -t &{K=V} The reference to the table. - +t &{K:V} The reference to the table. - .TE .SH RETURN Nothing. .SH EXAMPLES .EX ->> t.clear() +t := &{"A":1} +t.clear() +assert t == {} .EE diff --git a/man/man3/tomo-Table.get.3 b/man/man3/tomo-Table.get.3 index 97bae770..ede699cf 100644 --- a/man/man3/tomo-Table.get.3 +++ b/man/man3/tomo-Table.get.3 @@ -2,14 +2,14 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Table.get 3 2025-05-17 "Tomo man-pages" +.TH Table.get 3 2025-09-21 "Tomo man-pages" .SH NAME 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?) +.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. @@ -22,7 +22,7 @@ allbox; lb lb lbx lb l l l l. Name Type Description Default -t {K=V} The table. - +t {K:V} The table. - key K The key whose associated value is to be retrieved. - .TE .SH RETURN @@ -33,16 +33,9 @@ Default values for the table are ignored. .SH EXAMPLES .EX ->> t := {"A"=1, "B"=2} ->> t.get("A") -= 1? - ->> t.get("????") -= none - ->> t.get("A")! -= 1 - ->> t.get("????") or 0 -= 0 +t := {"A": 1, "B": 2} +assert t.get("A") == 1 +assert t.get("????") == none +assert t.get("A")! == 1 +assert t.get("????") or 0 == 0 .EE diff --git a/man/man3/tomo-Table.get_or_set.3 b/man/man3/tomo-Table.get_or_set.3 index d607171a..38e73a4b 100644 --- a/man/man3/tomo-Table.get_or_set.3 +++ b/man/man3/tomo-Table.get_or_set.3 @@ -2,14 +2,14 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Table.get_or_set 3 2025-05-17 "Tomo man-pages" +.TH Table.get_or_set 3 2025-09-21 "Tomo man-pages" .SH NAME 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?) +.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. @@ -22,7 +22,7 @@ allbox; lb lb lbx lb l l l l. Name Type Description Default -t &{K=V} The table. - +t &{K:V} The table. - key K The key whose associated value is to be retrieved. - default V The default value to insert and return if the key is not present in the table. - .TE @@ -35,14 +35,11 @@ The default value is only evaluated if the key is missing. .SH EXAMPLES .EX ->> t := &{"A"=@[1, 2, 3]; default=@[]} ->> t.get_or_set("A").insert(4) ->> t.get_or_set("B").insert(99) ->> t -= &{"A"=@[1, 2, 3, 4], "B"=@[99]} +t := &{"A": @[1, 2, 3]; default=@[]} +t.get_or_set("A").insert(4) +t.get_or_set("B").insert(99) +assert t == &{"A": @[1, 2, 3, 4], "B": @[99]} ->> t.get_or_set("C", @[0, 0, 0]) -= @[0, 0, 0] ->> t -= &{"A"=@[1, 2, 3, 4], "B"=@[99], "C"=@[0, 0, 0]} +assert t.get_or_set("C", @[0, 0, 0]) == @[0, 0, 0] +assert t == &{"A": @[1, 2, 3, 4], "B": @[99], "C": @[0, 0, 0]} .EE diff --git a/man/man3/tomo-Table.has.3 b/man/man3/tomo-Table.has.3 index 40111400..b2efffd6 100644 --- a/man/man3/tomo-Table.has.3 +++ b/man/man3/tomo-Table.has.3 @@ -2,14 +2,14 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Table.has 3 2025-05-17 "Tomo man-pages" +.TH Table.has 3 2025-09-21 "Tomo man-pages" .SH NAME Table.has \- check for a key .SH LIBRARY Tomo Standard Library .SH SYNOPSIS .nf -.BI Table.has\ :\ func(t:\ {K=V},\ key:\ K\ ->\ Bool) +.BI Table.has\ :\ func(t:\ {K:V},\ key:\ K\ ->\ Bool) .fi .SH DESCRIPTION Checks if the table contains a specified key. @@ -22,7 +22,7 @@ allbox; lb lb lbx lb l l l l. Name Type Description Default -t {K=V} The table. - +t {K:V} The table. - key K The key to check for presence. - .TE .SH RETURN @@ -30,8 +30,6 @@ key K The key to check for presence. - .SH EXAMPLES .EX ->> {"A"=1, "B"=2}.has("A") -= yes ->> {"A"=1, "B"=2}.has("xxx") -= no +assert {"A": 1, "B": 2}.has("A") == yes +assert {"A": 1, "B": 2}.has("xxx") == no .EE diff --git a/man/man3/tomo-Table.remove.3 b/man/man3/tomo-Table.remove.3 index 5fbb31d7..ce6010b3 100644 --- a/man/man3/tomo-Table.remove.3 +++ b/man/man3/tomo-Table.remove.3 @@ -2,14 +2,14 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Table.remove 3 2025-05-17 "Tomo man-pages" +.TH Table.remove 3 2025-09-21 "Tomo man-pages" .SH NAME Table.remove \- remove a table entry .SH LIBRARY Tomo Standard Library .SH SYNOPSIS .nf -.BI Table.remove\ :\ func(t:\ {K=V},\ key:\ K\ ->\ Void) +.BI Table.remove\ :\ func(t:\ {K:V},\ key:\ K\ ->\ Void) .fi .SH DESCRIPTION Removes the key-value pair associated with a specified key. @@ -22,7 +22,7 @@ allbox; lb lb lbx lb l l l l. Name Type Description Default -t {K=V} The reference to the table. - +t {K:V} The reference to the table. - key K The key of the key-value pair to remove. - .TE .SH RETURN @@ -30,8 +30,7 @@ Nothing. .SH EXAMPLES .EX -t := {"A"=1, "B"=2} +t := {"A": 1, "B": 2} t.remove("A") ->> t -= {"B"=2} +assert t == {"B": 2} .EE diff --git a/man/man3/tomo-Table.set.3 b/man/man3/tomo-Table.set.3 index b3ffdd1d..f1303189 100644 --- a/man/man3/tomo-Table.set.3 +++ b/man/man3/tomo-Table.set.3 @@ -2,14 +2,14 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Table.set 3 2025-05-17 "Tomo man-pages" +.TH Table.set 3 2025-09-21 "Tomo man-pages" .SH NAME 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) +.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. @@ -22,7 +22,7 @@ allbox; lb lb lbx lb l l l l. Name Type Description Default -t {K=V} The reference to the table. - +t {K:V} The reference to the table. - key K The key to set or update. - value V The value to associate with the key. - .TE @@ -31,8 +31,7 @@ Nothing. .SH EXAMPLES .EX -t := {"A"=1, "B"=2} +t := {"A": 1, "B": 2} t.set("C", 3) ->> t -= {"A"=1, "B"=2, "C"=3} +assert t == {"A": 1, "B": 2, "C": 3} .EE diff --git a/man/man3/tomo-Table.with_fallback.3 b/man/man3/tomo-Table.with_fallback.3 index 89c78fe1..c0719bd3 100644 --- a/man/man3/tomo-Table.with_fallback.3 +++ b/man/man3/tomo-Table.with_fallback.3 @@ -2,14 +2,14 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Table.with_fallback 3 2025-06-24 "Tomo man-pages" +.TH Table.with_fallback 3 2025-09-21 "Tomo man-pages" .SH NAME Table.with_fallback \- return a table with a new fallback .SH LIBRARY Tomo Standard Library .SH SYNOPSIS .nf -.BI Table.with_fallback\ :\ func(t:\ {K=V},\ fallback:\ {K=V}?\ ->\ {K=V}) +.BI Table.with_fallback\ :\ func(t:\ {K:V},\ fallback:\ {K:V}?\ ->\ {K:V}) .fi .SH DESCRIPTION Return a copy of a table with a different fallback table. @@ -22,19 +22,17 @@ allbox; lb lb lbx lb l l l l. Name Type Description Default -t {K=V} The table whose fallback will be replaced. - -fallback {K=V}? The new fallback table value. - +t {K:V} The table whose fallback will be replaced. - +fallback {K:V}? The new fallback table value. - .TE .SH RETURN The original table with a different fallback. .SH EXAMPLES .EX -t := {"A"=1; fallback={"B"=2}} -t2 = t.with_fallback({"B"=3"}) ->> t2["B"] -= 3? +t := {"A": 1; fallback={"B": 2}} +t2 = t.with_fallback({"B": 3"}) +assert t2["B"] == 3 t3 = t.with_fallback(none) ->> t2["B"] -= none +assert t2["B"] == none .EE diff --git a/man/man3/tomo-Text.as_c_string.3 b/man/man3/tomo-Text.as_c_string.3 index ad3c0a2d..ef49eeb7 100644 --- a/man/man3/tomo-Text.as_c_string.3 +++ b/man/man3/tomo-Text.as_c_string.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.as_c_string 3 2025-04-30 "Tomo man-pages" +.TH Text.as_c_string 3 2025-09-21 "Tomo man-pages" .SH NAME Text.as_c_string \- convert to C-style string .SH LIBRARY @@ -29,6 +29,5 @@ A C-style string (`CString`) representing the text. .SH EXAMPLES .EX ->> "Hello".as_c_string() -= CString("Hello") +assert "Hello".as_c_string() == CString("Hello") .EE diff --git a/man/man3/tomo-Text.at.3 b/man/man3/tomo-Text.at.3 index e9b3e8ae..2d46c256 100644 --- a/man/man3/tomo-Text.at.3 +++ b/man/man3/tomo-Text.at.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.at 3 2025-04-30 "Tomo man-pages" +.TH Text.at 3 2025-09-21 "Tomo man-pages" .SH NAME Text.at \- get a letter .SH LIBRARY @@ -33,6 +33,5 @@ Negative indices are counted from the back of the text, so `-1` means the last c .SH EXAMPLES .EX ->> "Amélie".at(3) -= "é" +assert "Amélie".at(3) == "é" .EE diff --git a/man/man3/tomo-Text.caseless_equals.3 b/man/man3/tomo-Text.caseless_equals.3 index 97850208..1470c4db 100644 --- a/man/man3/tomo-Text.caseless_equals.3 +++ b/man/man3/tomo-Text.caseless_equals.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.caseless_equals 3 2025-04-30 "Tomo man-pages" +.TH Text.caseless_equals 3 2025-09-21 "Tomo man-pages" .SH NAME Text.caseless_equals \- case-insensitive comparison .SH LIBRARY @@ -31,10 +31,8 @@ language Text The ISO 639 language code for which casing rules to use. "C" .SH EXAMPLES .EX ->> "A".caseless_equals("a") -= yes +assert "A".caseless_equals("a") == yes # Turkish lowercase "I" is "ı" (dotless I), not "i" ->> "I".caseless_equals("i", language="tr_TR") -= no +assert "I".caseless_equals("i", language="tr_TR") == no .EE diff --git a/man/man3/tomo-Text.codepoint_names.3 b/man/man3/tomo-Text.codepoint_names.3 index 36c9ba06..61a4c9a5 100644 --- a/man/man3/tomo-Text.codepoint_names.3 +++ b/man/man3/tomo-Text.codepoint_names.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.codepoint_names 3 2025-04-30 "Tomo man-pages" +.TH Text.codepoint_names 3 2025-09-21 "Tomo man-pages" .SH NAME Text.codepoint_names \- get unicode codepoint names .SH LIBRARY @@ -29,6 +29,12 @@ A list of codepoint names (`[Text]`). .SH EXAMPLES .EX ->> "Amélie".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"] +assert "Amélie".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", +] .EE diff --git a/man/man3/tomo-Text.ends_with.3 b/man/man3/tomo-Text.ends_with.3 index 38fa4c0b..7b5ff696 100644 --- a/man/man3/tomo-Text.ends_with.3 +++ b/man/man3/tomo-Text.ends_with.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.ends_with 3 2025-08-16 "Tomo man-pages" +.TH Text.ends_with 3 2025-09-21 "Tomo man-pages" .SH NAME Text.ends_with \- check suffix .SH LIBRARY @@ -31,11 +31,8 @@ remainder &Text? If non-none, this value will be set to the rest of the text up .SH EXAMPLES .EX ->> "hello world".ends_with("world") -= yes +assert "hello world".ends_with("world") == yes remainder : Text ->> "hello world".ends_with("world", &remainder) -= yes ->> remainder -= "hello " +assert "hello world".ends_with("world", &remainder) == yes +assert remainder == "hello " .EE diff --git a/man/man3/tomo-Text.from.3 b/man/man3/tomo-Text.from.3 index 43ab22ab..6132c572 100644 --- a/man/man3/tomo-Text.from.3 +++ b/man/man3/tomo-Text.from.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.from 3 2025-04-30 "Tomo man-pages" +.TH Text.from 3 2025-09-21 "Tomo man-pages" .SH NAME Text.from \- slice from a starting index .SH LIBRARY @@ -33,9 +33,6 @@ A negative index counts backwards from the end of the text, so `-1` refers to th .SH EXAMPLES .EX ->> "hello".from(2) -= "ello" - ->> "hello".from(-2) -= "lo" +assert "hello".from(2) == "ello" +assert "hello".from(-2) == "lo" .EE diff --git a/man/man3/tomo-Text.from_c_string.3 b/man/man3/tomo-Text.from_c_string.3 index 2670f484..98b153d8 100644 --- a/man/man3/tomo-Text.from_c_string.3 +++ b/man/man3/tomo-Text.from_c_string.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.from_c_string 3 2025-04-30 "Tomo man-pages" +.TH Text.from_c_string 3 2025-09-21 "Tomo man-pages" .SH NAME Text.from_c_string \- convert C-style string to text .SH LIBRARY @@ -29,6 +29,5 @@ A `Text` value representing the C-style string. .SH EXAMPLES .EX ->> Text.from_c_string(CString("Hello")) -= "Hello" +assert Text.from_c_string(CString("Hello")) == "Hello" .EE diff --git a/man/man3/tomo-Text.from_utf16.3 b/man/man3/tomo-Text.from_utf16.3 index d4eaea02..6668baf0 100644 --- a/man/man3/tomo-Text.from_utf16.3 +++ b/man/man3/tomo-Text.from_utf16.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.from_utf16 3 2025-09-09 "Tomo man-pages" +.TH Text.from_utf16 3 2025-09-21 "Tomo man-pages" .SH NAME Text.from_utf16 \- convert UTF16 list to text .SH LIBRARY @@ -32,8 +32,6 @@ The text will be normalized, so the resulting text's UTF16 sequence may not exac .SH EXAMPLES .EX ->> Text.from_utf16([197, 107, 101]) -= "Åke" ->> Text.from_utf16([12371, 12435, 12395, 12385, 12399, 19990, 30028]) -= "こんにちは世界".utf16() +assert Text.from_utf16([197, 107, 101]) == "Åke" +assert Text.from_utf16([12371, 12435, 12395, 12385, 12399, 19990, 30028]) == "こんにちは世界".utf16() .EE diff --git a/man/man3/tomo-Text.from_utf32.3 b/man/man3/tomo-Text.from_utf32.3 index 31fc344f..d93ad2c9 100644 --- a/man/man3/tomo-Text.from_utf32.3 +++ b/man/man3/tomo-Text.from_utf32.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.from_utf32 3 2025-09-09 "Tomo man-pages" +.TH Text.from_utf32 3 2025-09-21 "Tomo man-pages" .SH NAME Text.from_utf32 \- convert UTF32 codepoints to text .SH LIBRARY @@ -32,6 +32,5 @@ The text will be normalized, so the resulting text's codepoints may not exactly .SH EXAMPLES .EX ->> Text.from_utf32([197, 107, 101]) -= "Åke" +assert Text.from_utf32([197, 107, 101]) == "Åke" .EE diff --git a/man/man3/tomo-Text.from_utf8.3 b/man/man3/tomo-Text.from_utf8.3 index ead65dc6..ec5261ec 100644 --- a/man/man3/tomo-Text.from_utf8.3 +++ b/man/man3/tomo-Text.from_utf8.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.from_utf8 3 2025-09-09 "Tomo man-pages" +.TH Text.from_utf8 3 2025-09-21 "Tomo man-pages" .SH NAME Text.from_utf8 \- convert UTF8 byte list to text .SH LIBRARY @@ -32,6 +32,5 @@ The text will be normalized, so the resulting text's UTF8 bytes may not exactly .SH EXAMPLES .EX ->> Text.from_utf8([195, 133, 107, 101]) -= "Åke" +assert Text.from_utf8([195, 133, 107, 101]) == "Åke" .EE diff --git a/man/man3/tomo-Text.has.3 b/man/man3/tomo-Text.has.3 index c9990add..75b6b0c9 100644 --- a/man/man3/tomo-Text.has.3 +++ b/man/man3/tomo-Text.has.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.has 3 2025-04-30 "Tomo man-pages" +.TH Text.has 3 2025-09-21 "Tomo man-pages" .SH NAME Text.has \- check for substring .SH LIBRARY @@ -30,8 +30,6 @@ target Text The text to search for. - .SH EXAMPLES .EX ->> "hello world".has("wo") -= yes ->> "hello world".has("xxx") -= no +assert "hello world".has("wo") == yes +assert "hello world".has("xxx") == no .EE diff --git a/man/man3/tomo-Text.join.3 b/man/man3/tomo-Text.join.3 index 3552523e..b736f721 100644 --- a/man/man3/tomo-Text.join.3 +++ b/man/man3/tomo-Text.join.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.join 3 2025-04-30 "Tomo man-pages" +.TH Text.join 3 2025-09-21 "Tomo man-pages" .SH NAME Text.join \- concatenate with separator .SH LIBRARY @@ -30,6 +30,5 @@ A single `Text` value with the pieces joined by the glue. .SH EXAMPLES .EX ->> ", ".join(["one", "two", "three"]) -= "one, two, three" +assert ", ".join(["one", "two", "three"]) == "one, two, three" .EE diff --git a/man/man3/tomo-Text.left_pad.3 b/man/man3/tomo-Text.left_pad.3 index 28b1d000..e79e4ad6 100644 --- a/man/man3/tomo-Text.left_pad.3 +++ b/man/man3/tomo-Text.left_pad.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.left_pad 3 2025-04-30 "Tomo man-pages" +.TH Text.left_pad 3 2025-09-21 "Tomo man-pages" .SH NAME Text.left_pad \- left-pad text .SH LIBRARY @@ -32,8 +32,6 @@ Text with length at least `width`, with extra padding on the left as needed. If .SH EXAMPLES .EX ->> "x".left_pad(5) -= " x" ->> "x".left_pad(5, "ABC") -= "ABCAx" +assert "x".left_pad(5) == " x" +assert "x".left_pad(5, "ABC") == "ABCAx" .EE diff --git a/man/man3/tomo-Text.lines.3 b/man/man3/tomo-Text.lines.3 index 855abbd8..60aa4430 100644 --- a/man/man3/tomo-Text.lines.3 +++ b/man/man3/tomo-Text.lines.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.lines 3 2025-04-30 "Tomo man-pages" +.TH Text.lines 3 2025-09-21 "Tomo man-pages" .SH NAME Text.lines \- get list of lines .SH LIBRARY @@ -29,14 +29,9 @@ A list of substrings resulting from the split. .SH EXAMPLES .EX ->> "one\[rs]ntwo\[rs]nthree".lines() -= ["one", "two", "three"] ->> "one\[rs]ntwo\[rs]nthree\[rs]n".lines() -= ["one", "two", "three"] ->> "one\[rs]ntwo\[rs]nthree\[rs]n\[rs]n".lines() -= ["one", "two", "three", ""] ->> "one\[rs]r\[rs]ntwo\[rs]r\[rs]nthree\[rs]r\[rs]n".lines() -= ["one", "two", "three"] ->> "".lines() -= [] +assert "one\[rs]ntwo\[rs]nthree".lines() == ["one", "two", "three"] +assert "one\[rs]ntwo\[rs]nthree\[rs]n".lines() == ["one", "two", "three"] +assert "one\[rs]ntwo\[rs]nthree\[rs]n\[rs]n".lines() == ["one", "two", "three", ""] +assert "one\[rs]r\[rs]ntwo\[rs]r\[rs]nthree\[rs]r\[rs]n".lines() == ["one", "two", "three"] +assert "".lines() == [] .EE diff --git a/man/man3/tomo-Text.lower.3 b/man/man3/tomo-Text.lower.3 index 079fd01b..877227e7 100644 --- a/man/man3/tomo-Text.lower.3 +++ b/man/man3/tomo-Text.lower.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.lower 3 2025-04-30 "Tomo man-pages" +.TH Text.lower 3 2025-09-21 "Tomo man-pages" .SH NAME Text.lower \- convert to lowercase .SH LIBRARY @@ -30,9 +30,6 @@ The lowercase version of the text. .SH EXAMPLES .EX ->> "AMÉLIE".lower() -= "amélie" - ->> "I".lower(language="tr_TR") ->> "ı" +assert "AMÉLIE".lower() == "amélie" +assert "I".lower(language="tr_TR") == "ı" .EE diff --git a/man/man3/tomo-Text.middle_pad.3 b/man/man3/tomo-Text.middle_pad.3 index 815f54f1..8b57bf6e 100644 --- a/man/man3/tomo-Text.middle_pad.3 +++ b/man/man3/tomo-Text.middle_pad.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.middle_pad 3 2025-04-30 "Tomo man-pages" +.TH Text.middle_pad 3 2025-09-21 "Tomo man-pages" .SH NAME Text.middle_pad \- pad text, centered .SH LIBRARY @@ -32,8 +32,6 @@ Text with length at least `width`, with extra padding on the left and right as n .SH EXAMPLES .EX ->> "x".middle_pad(6) -= " x " ->> "x".middle_pad(10, "ABC") -= "ABCAxABCAB" +assert "x".middle_pad(6) == " x " +assert "x".middle_pad(10, "ABC") == "ABCAxABCAB" .EE diff --git a/man/man3/tomo-Text.quoted.3 b/man/man3/tomo-Text.quoted.3 index 83a40266..8f6824fd 100644 --- a/man/man3/tomo-Text.quoted.3 +++ b/man/man3/tomo-Text.quoted.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.quoted 3 2025-04-30 "Tomo man-pages" +.TH Text.quoted 3 2025-09-21 "Tomo man-pages" .SH NAME Text.quoted \- add quotation marks and escapes .SH LIBRARY @@ -31,6 +31,5 @@ The text formatted as a quoted text. .SH EXAMPLES .EX ->> "one\[rs]ntwo".quoted() -= "\[rs]"one\[rs]\[rs]ntwo\[rs]"" +assert "one\[rs]ntwo".quoted() == "\[rs]"one\[rs]\[rs]ntwo\[rs]"" .EE diff --git a/man/man3/tomo-Text.repeat.3 b/man/man3/tomo-Text.repeat.3 index 24effec4..fdc9561f 100644 --- a/man/man3/tomo-Text.repeat.3 +++ b/man/man3/tomo-Text.repeat.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.repeat 3 2025-04-30 "Tomo man-pages" +.TH Text.repeat 3 2025-09-21 "Tomo man-pages" .SH NAME Text.repeat \- repeat text .SH LIBRARY @@ -30,6 +30,5 @@ The text repeated the given number of times. .SH EXAMPLES .EX ->> "Abc".repeat(3) -= "AbcAbcAbc" +assert "Abc".repeat(3) == "AbcAbcAbc" .EE diff --git a/man/man3/tomo-Text.replace.3 b/man/man3/tomo-Text.replace.3 index 6d4f20b5..7a272106 100644 --- a/man/man3/tomo-Text.replace.3 +++ b/man/man3/tomo-Text.replace.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.replace 3 2025-04-30 "Tomo man-pages" +.TH Text.replace 3 2025-09-21 "Tomo man-pages" .SH NAME Text.replace \- replace a substring .SH LIBRARY @@ -31,6 +31,5 @@ The text with occurrences of the target replaced. .SH EXAMPLES .EX ->> "Hello world".replace("world", "there") -= "Hello there" +assert "Hello world".replace("world", "there") == "Hello there" .EE diff --git a/man/man3/tomo-Text.reversed.3 b/man/man3/tomo-Text.reversed.3 index c855c909..51b37acb 100644 --- a/man/man3/tomo-Text.reversed.3 +++ b/man/man3/tomo-Text.reversed.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.reversed 3 2025-04-30 "Tomo man-pages" +.TH Text.reversed 3 2025-09-21 "Tomo man-pages" .SH NAME Text.reversed \- get a reversed copy .SH LIBRARY @@ -29,6 +29,5 @@ A reversed version of the text. .SH EXAMPLES .EX ->> "Abc".reversed() -= "cbA" +assert "Abc".reversed() == "cbA" .EE diff --git a/man/man3/tomo-Text.right_pad.3 b/man/man3/tomo-Text.right_pad.3 index ef0cd189..0fb128cb 100644 --- a/man/man3/tomo-Text.right_pad.3 +++ b/man/man3/tomo-Text.right_pad.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.right_pad 3 2025-04-30 "Tomo man-pages" +.TH Text.right_pad 3 2025-09-21 "Tomo man-pages" .SH NAME Text.right_pad \- right-pad text .SH LIBRARY @@ -32,8 +32,6 @@ Text with length at least `width`, with extra padding on the right as needed. If .SH EXAMPLES .EX ->> "x".right_pad(5) -= "x " ->> "x".right_pad(5, "ABC") -= "xABCA" +assert "x".right_pad(5) == "x " +assert "x".right_pad(5, "ABC") == "xABCA" .EE diff --git a/man/man3/tomo-Text.slice.3 b/man/man3/tomo-Text.slice.3 index a716b699..48e0516a 100644 --- a/man/man3/tomo-Text.slice.3 +++ b/man/man3/tomo-Text.slice.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.slice 3 2025-04-30 "Tomo man-pages" +.TH Text.slice 3 2025-09-21 "Tomo man-pages" .SH NAME Text.slice \- get a slice of a text .SH LIBRARY @@ -34,12 +34,7 @@ A negative index counts backwards from the end of the text, so `-1` refers to th .SH EXAMPLES .EX ->> "hello".slice(2, 3) -= "el" - ->> "hello".slice(to=-2) -= "hell" - ->> "hello".slice(from=2) -= "ello" +assert "hello".slice(2, 3) == "el" +assert "hello".slice(to=-2) == "hell" +assert "hello".slice(from=2) == "ello" .EE diff --git a/man/man3/tomo-Text.split.3 b/man/man3/tomo-Text.split.3 index 5eba316f..8634c509 100644 --- a/man/man3/tomo-Text.split.3 +++ b/man/man3/tomo-Text.split.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.split 3 2025-04-30 "Tomo man-pages" +.TH Text.split 3 2025-09-21 "Tomo man-pages" .SH NAME Text.split \- split a text by a delimiter .SH LIBRARY @@ -34,9 +34,6 @@ If an empty text is given as the delimiter, then each split will be the graphica .SH EXAMPLES .EX ->> "one,two,,three".split(",") -= ["one", "two", "", "three"] - ->> "abc".split() -= ["a", "b", "c"] +assert "one,two,,three".split(",") == ["one", "two", "", "three"] +assert "abc".split() == ["a", "b", "c"] .EE diff --git a/man/man3/tomo-Text.split_any.3 b/man/man3/tomo-Text.split_any.3 index 7a57433f..6c77d8d6 100644 --- a/man/man3/tomo-Text.split_any.3 +++ b/man/man3/tomo-Text.split_any.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.split_any 3 2025-04-30 "Tomo man-pages" +.TH Text.split_any 3 2025-09-21 "Tomo man-pages" .SH NAME Text.split_any \- split a text by multiple delimiters .SH LIBRARY @@ -34,6 +34,5 @@ To split based on an exact delimiter, use Text.split(). .SH EXAMPLES .EX ->> "one, two,,three".split_any(", ") -= ["one", "two", "three"] +assert "one, two,,three".split_any(", ") == ["one", "two", "three"] .EE diff --git a/man/man3/tomo-Text.starts_with.3 b/man/man3/tomo-Text.starts_with.3 index fafa2a55..ac35fa8d 100644 --- a/man/man3/tomo-Text.starts_with.3 +++ b/man/man3/tomo-Text.starts_with.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.starts_with 3 2025-08-16 "Tomo man-pages" +.TH Text.starts_with 3 2025-09-21 "Tomo man-pages" .SH NAME Text.starts_with \- check prefix .SH LIBRARY @@ -31,11 +31,8 @@ remainder &Text? If non-none, this value will be set to the rest of the text aft .SH EXAMPLES .EX ->> "hello world".starts_with("hello") -= yes +assert "hello world".starts_with("hello") == yes remainder : Text ->> "hello world".starts_with("hello", &remainder) -= yes ->> remainder -= " world" +assert "hello world".starts_with("hello", &remainder) == yes +assert remainder == " world" .EE diff --git a/man/man3/tomo-Text.title.3 b/man/man3/tomo-Text.title.3 index dfdecf21..d1b3e962 100644 --- a/man/man3/tomo-Text.title.3 +++ b/man/man3/tomo-Text.title.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.title 3 2025-04-30 "Tomo man-pages" +.TH Text.title 3 2025-09-21 "Tomo man-pages" .SH NAME Text.title \- titlecase .SH LIBRARY @@ -30,10 +30,8 @@ The text in title case. .SH EXAMPLES .EX ->> "amélie".title() -= "Amélie" +assert "amélie".title() == "Amélie" # In Turkish, uppercase "i" is "İ" ->> "i".title(language="tr_TR") -= "İ" +assert "i".title(language="tr_TR") == "İ" .EE diff --git a/man/man3/tomo-Text.to.3 b/man/man3/tomo-Text.to.3 index 702698a0..4de082d3 100644 --- a/man/man3/tomo-Text.to.3 +++ b/man/man3/tomo-Text.to.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.to 3 2025-04-30 "Tomo man-pages" +.TH Text.to 3 2025-09-21 "Tomo man-pages" .SH NAME Text.to \- slice to an end index .SH LIBRARY @@ -33,9 +33,6 @@ A negative index counts backwards from the end of the text, so `-1` refers to th .SH EXAMPLES .EX ->> "goodbye".to(3) -= "goo" - ->> "goodbye".to(-2) -= "goodby" +assert "goodbye".to(3) == "goo" +assert "goodbye".to(-2) == "goodby" .EE diff --git a/man/man3/tomo-Text.trim.3 b/man/man3/tomo-Text.trim.3 index eec1750c..b7daa310 100644 --- a/man/man3/tomo-Text.trim.3 +++ b/man/man3/tomo-Text.trim.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.trim 3 2025-04-30 "Tomo man-pages" +.TH Text.trim 3 2025-09-21 "Tomo man-pages" .SH NAME Text.trim \- trim characters .SH LIBRARY @@ -32,12 +32,7 @@ The text without the trim characters at either end. .SH EXAMPLES .EX ->> " x y z \[rs]n".trim() -= "x y z" - ->> "one,".trim(",") -= "one" - ->> " xyz ".trim(right=no) -= "xyz " +assert " x y z \[rs]n".trim() == "x y z" +assert "one,".trim(",") == "one" +assert " xyz ".trim(right=no) == "xyz " .EE diff --git a/man/man3/tomo-Text.upper.3 b/man/man3/tomo-Text.upper.3 index 522702db..dc10ff21 100644 --- a/man/man3/tomo-Text.upper.3 +++ b/man/man3/tomo-Text.upper.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.upper 3 2025-04-30 "Tomo man-pages" +.TH Text.upper 3 2025-09-21 "Tomo man-pages" .SH NAME Text.upper \- uppercase .SH LIBRARY @@ -30,10 +30,8 @@ The uppercase version of the text. .SH EXAMPLES .EX ->> "amélie".upper() -= "AMÉLIE" +assert "amélie".upper() == "AMÉLIE" # In Turkish, uppercase "i" is "İ" ->> "i".upper(language="tr_TR") -= "İ" +assert "i".upper(language="tr_TR") == "İ" .EE diff --git a/man/man3/tomo-Text.utf16.3 b/man/man3/tomo-Text.utf16.3 index 2b3da2b1..2d5d0817 100644 --- a/man/man3/tomo-Text.utf16.3 +++ b/man/man3/tomo-Text.utf16.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.utf16 3 2025-09-09 "Tomo man-pages" +.TH Text.utf16 3 2025-09-21 "Tomo man-pages" .SH NAME Text.utf16 \- get UTF16 codepoints .SH LIBRARY @@ -29,8 +29,6 @@ A list of 16-bit integer Unicode code points (`[Int16]`). .SH EXAMPLES .EX ->> "Åke".utf16() -= [197, 107, 101] ->> "こんにちは世界".utf16() -= [12371, 12435, 12395, 12385, 12399, 19990, 30028] +assert "Åke".utf16() == [197, 107, 101] +assert "こんにちは世界".utf16() == [12371, 12435, 12395, 12385, 12399, 19990, 30028] .EE diff --git a/man/man3/tomo-Text.utf32.3 b/man/man3/tomo-Text.utf32.3 index ff37ba9c..a74b04d2 100644 --- a/man/man3/tomo-Text.utf32.3 +++ b/man/man3/tomo-Text.utf32.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.utf32 3 2025-09-09 "Tomo man-pages" +.TH Text.utf32 3 2025-09-21 "Tomo man-pages" .SH NAME Text.utf32 \- get UTF32 codepoints .SH LIBRARY @@ -29,6 +29,5 @@ A list of 32-bit integer Unicode code points (`[Int32]`). .SH EXAMPLES .EX ->> "Amélie".utf32() -= [65, 109, 233, 108, 105, 101] +assert "Amélie".utf32() == [65, 109, 233, 108, 105, 101] .EE diff --git a/man/man3/tomo-Text.utf8.3 b/man/man3/tomo-Text.utf8.3 index 80a91fb9..e64bbaf1 100644 --- a/man/man3/tomo-Text.utf8.3 +++ b/man/man3/tomo-Text.utf8.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.utf8 3 2025-09-09 "Tomo man-pages" +.TH Text.utf8 3 2025-09-21 "Tomo man-pages" .SH NAME Text.utf8 \- get UTF8 bytes .SH LIBRARY @@ -29,6 +29,5 @@ A list of bytes (`[Byte]`) representing the text in UTF8 encoding. .SH EXAMPLES .EX ->> "Amélie".utf8() -= [65, 109, 195, 169, 108, 105, 101] +assert "Amélie".utf8() == [65, 109, 195, 169, 108, 105, 101] .EE diff --git a/man/man3/tomo-Text.width.3 b/man/man3/tomo-Text.width.3 index 796a4e47..7118c9bb 100644 --- a/man/man3/tomo-Text.width.3 +++ b/man/man3/tomo-Text.width.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.width 3 2025-04-30 "Tomo man-pages" +.TH Text.width 3 2025-09-21 "Tomo man-pages" .SH NAME Text.width \- get display width .SH LIBRARY @@ -32,8 +32,6 @@ This will not always be exactly accurate when your terminal's font rendering can .SH EXAMPLES .EX ->> "Amélie".width() -= 6 ->> "🤠".width() -= 2 +assert "Amélie".width() == 6 +assert "🤠".width() == 2 .EE diff --git a/man/man3/tomo-Text.without_prefix.3 b/man/man3/tomo-Text.without_prefix.3 index 34d55ea3..12479791 100644 --- a/man/man3/tomo-Text.without_prefix.3 +++ b/man/man3/tomo-Text.without_prefix.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.without_prefix 3 2025-04-30 "Tomo man-pages" +.TH Text.without_prefix 3 2025-09-21 "Tomo man-pages" .SH NAME Text.without_prefix \- remove prefix .SH LIBRARY @@ -30,8 +30,6 @@ A text without the given prefix (if present) or the unmodified text if the prefi .SH EXAMPLES .EX ->> "foo:baz".without_prefix("foo:") -= "baz" ->> "qux".without_prefix("foo:") -= "qux" +assert "foo:baz".without_prefix("foo:") == "baz" +assert "qux".without_prefix("foo:") == "qux" .EE diff --git a/man/man3/tomo-Text.without_suffix.3 b/man/man3/tomo-Text.without_suffix.3 index d5510b77..45d818a7 100644 --- a/man/man3/tomo-Text.without_suffix.3 +++ b/man/man3/tomo-Text.without_suffix.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH Text.without_suffix 3 2025-04-30 "Tomo man-pages" +.TH Text.without_suffix 3 2025-09-21 "Tomo man-pages" .SH NAME Text.without_suffix \- remove suffix .SH LIBRARY @@ -30,8 +30,6 @@ A text without the given suffix (if present) or the unmodified text if the suffi .SH EXAMPLES .EX ->> "baz.foo".without_suffix(".foo") -= "baz" ->> "qux".without_suffix(".foo") -= "qux" +assert "baz.foo".without_suffix(".foo") == "baz" +assert "qux".without_suffix(".foo") == "qux" .EE diff --git a/man/man3/tomo-ask.3 b/man/man3/tomo-ask.3 index 88aa0964..684efd63 100644 --- a/man/man3/tomo-ask.3 +++ b/man/man3/tomo-ask.3 @@ -2,7 +2,7 @@ .\" Copyright (c) 2025 Bruce Hill .\" All rights reserved. .\" -.TH ask 3 2025-05-17 "Tomo man-pages" +.TH ask 3 2025-09-21 "Tomo man-pages" .SH NAME ask \- get user input .SH LIBRARY @@ -34,6 +34,5 @@ When a program is receiving input from a pipe or writing its output to a pipe, t .SH EXAMPLES .EX ->> ask("What's your name? ") -= "Arthur Dent" +assert ask("What's your name? ") == "Arthur Dent" .EE |
