diff options
Diffstat (limited to 'stdlib/source/documentation/lux/math/number')
6 files changed, 42 insertions, 40 deletions
diff --git a/stdlib/source/documentation/lux/math/number/complex.lux b/stdlib/source/documentation/lux/math/number/complex.lux index 2df1f2a71..239a6eddf 100644 --- a/stdlib/source/documentation/lux/math/number/complex.lux +++ b/stdlib/source/documentation/lux/math/number/complex.lux @@ -55,7 +55,8 @@ ($.definition /.complex "Complex literals." - [(complex real imaginary)] - ["The imaginary part can be omitted if it's +0.0." - (complex real)]) + ($.example (complex real imaginary)) + + ($.comment "The imaginary part can be omitted if it's +0.0.") + ($.example (complex real))) )) diff --git a/stdlib/source/documentation/lux/math/number/frac.lux b/stdlib/source/documentation/lux/math/number/frac.lux index d543143f6..b65bc0936 100644 --- a/stdlib/source/documentation/lux/math/number/frac.lux +++ b/stdlib/source/documentation/lux/math/number/frac.lux @@ -49,15 +49,15 @@ ($.definition /.pow "" - [(pow param subject)]) + ($.example (pow param subject))) ($.definition /.atan_2 "" - [(atan_2 x y)]) + ($.example (atan_2 x y))) ($.definition /.log_by "" - [(log_by base it)]) + ($.example (log_by base it))) )) (`` (def .public documentation @@ -93,23 +93,23 @@ ($.definition /.= "Frac(tion) equivalence." - [(= reference sample)]) + ($.example (= reference sample))) ($.definition /.< "Frac(tion) less-than." - [(< reference sample)]) + ($.example (< reference sample))) ($.definition /.<= "Frac(tion) less-than or equal." - [(<= reference sample)]) + ($.example (<= reference sample))) ($.definition /.> "Frac(tion) greater-than." - [(> reference sample)]) + ($.example (> reference sample))) ($.definition /.>= "Frac(tion) greater-than or equal." - [(>= reference sample)]) + ($.example (>= reference sample))) (,, (with_template [<name> <doc>] [($.definition <name> @@ -124,7 +124,7 @@ ($.definition /./% "" - [(/% param subject)]) + ($.example (/% param subject))) (,, (with_template [<name> <doc>] [($.definition <name> @@ -145,15 +145,15 @@ ($.definition /.not_a_number? "Tests whether a frac is actually not-a-number." - [(not_a_number? it)]) + ($.example (not_a_number? it))) ($.definition /.approximately? "" - [(approximately? margin_of_error standard value)]) + ($.example (approximately? margin_of_error standard value))) ($.definition /.mod "" - [(mod divisor dividend)]) + ($.example (mod divisor dividend))) ..math ))) diff --git a/stdlib/source/documentation/lux/math/number/i64.lux b/stdlib/source/documentation/lux/math/number/i64.lux index 644c6e7e3..2180fcffd 100644 --- a/stdlib/source/documentation/lux/math/number/i64.lux +++ b/stdlib/source/documentation/lux/math/number/i64.lux @@ -43,7 +43,7 @@ ($.definition /.bit "A mask with only a specific bit set." - [(bit position)]) + ($.example (bit position))) ($.definition /.sign "A mask for the sign bit of ints.") @@ -53,11 +53,11 @@ ($.definition /.mask "Mask a block of bits of the specified size." - [(mask amount_of_bits)]) + ($.example (mask amount_of_bits))) ($.definition /.ones "Count the number of 1s in a bit-map." - [(ones it)]) + ($.example (ones it))) (,, (with_template [<name> <doc>] [($.definition <name> @@ -70,20 +70,20 @@ ($.definition /.one? "" - [(one? index input)]) + ($.example (one? index input))) ($.definition /.zero? "" - [(zero? index input)]) + ($.example (zero? index input))) ($.definition /.region "A mask for a block of bits of the given size, starting at the given offset." - [(region offset size)]) + ($.example (region offset size))) ($.definition (/.Sub width) "A sub-space of I64 with a reduce amount of bits.") ($.definition /.sub "Given a width in the interval (0,64), yields an implementation for integers of that width." - [(sub width)]) + ($.example (sub width))) ))) diff --git a/stdlib/source/documentation/lux/math/number/int.lux b/stdlib/source/documentation/lux/math/number/int.lux index f7805842d..187cfd5e4 100644 --- a/stdlib/source/documentation/lux/math/number/int.lux +++ b/stdlib/source/documentation/lux/math/number/int.lux @@ -36,23 +36,23 @@ ($.definition /.= "Int(eger) equivalence." - [(= reference sample)]) + ($.example (= reference sample))) ($.definition /.< "Int(eger) less-than." - [(< reference sample)]) + ($.example (< reference sample))) ($.definition /.<= "Int(eger) less-than or equal." - [(<= reference sample)]) + ($.example (<= reference sample))) ($.definition /.> "Int(eger) greater-than." - [(> reference sample)]) + ($.example (> reference sample))) ($.definition /.>= "Int(eger) greater-than or equal." - [(>= reference sample)]) + ($.example (>= reference sample))) (,, (with_template [<name> <doc>] [($.definition <name> @@ -86,7 +86,7 @@ ($.definition /.mod (format "Integer modulo." \n "Note: The modulo and the remainder are not the same.") - [(mod divisor dividend)]) + ($.example (mod divisor dividend))) ($.definition /.gcd "Greatest Common Divisor.") @@ -99,5 +99,5 @@ ($.definition /.right_shifted "Signed/arithmetic bitwise right-shift." - [(right_shifted parameter subject)]) + ($.example (right_shifted parameter subject))) ))) diff --git a/stdlib/source/documentation/lux/math/number/ratio.lux b/stdlib/source/documentation/lux/math/number/ratio.lux index e74805a90..6d93e699e 100644 --- a/stdlib/source/documentation/lux/math/number/ratio.lux +++ b/stdlib/source/documentation/lux/math/number/ratio.lux @@ -36,7 +36,8 @@ ($.definition /.ratio "Rational literals." - [(ratio numerator denominator)] - ["The denominator can be omitted if it is 1." - (ratio numerator)]) + ($.example (ratio numerator denominator)) + + ($.comment "The denominator can be omitted if it is 1.") + ($.example (ratio numerator))) )) diff --git a/stdlib/source/documentation/lux/math/number/rev.lux b/stdlib/source/documentation/lux/math/number/rev.lux index 323ccc467..d22c6c40e 100644 --- a/stdlib/source/documentation/lux/math/number/rev.lux +++ b/stdlib/source/documentation/lux/math/number/rev.lux @@ -43,23 +43,23 @@ ($.definition /.= "Rev(olution) equivalence." - [(= reference sample)]) + ($.example (= reference sample))) ($.definition /.< "Rev(olution) less-than." - [(< reference sample)]) + ($.example (< reference sample))) ($.definition /.<= "Rev(olution) less-than or equal." - [(<= reference sample)]) + ($.example (<= reference sample))) ($.definition /.> "Rev(olution) greater-than." - [(> reference sample)]) + ($.example (> reference sample))) ($.definition /.>= "Rev(olution) greater-than or equal." - [(>= reference sample)]) + ($.example (>= reference sample))) (,, (with_template [<name> <doc>] [($.definition <name> @@ -83,13 +83,13 @@ ($.definition /.up "" - [(up scale subject)]) + ($.example (up scale subject))) ($.definition /.down "" - [(down scale subject)]) + ($.example (down scale subject))) ($.definition /.reciprocal "Rev(olution) reciprocal of a Nat(ural)." - [(reciprocal numerator)]) + ($.example (reciprocal numerator))) ))) |