Skip to content

Commit

Permalink
reword some basic function descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
kaikalii committed Oct 8, 2023
1 parent 7305f58 commit 4a4c3dd
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions src/primitive/defs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -238,20 +238,20 @@ primitive!(
MonadicPervasive,
("negate", AsciiToken::Backtick, '¯')
),
/// The absolute value of a number
/// Get the absolute value of a number
///
/// ex: ⌵ ¯1
/// ex: ⌵ 1
///
/// The glyph looks like the graph of `|x|`.
(1, Abs, MonadicPervasive, ("absolute value", '⌵')),
/// The square root of a number
/// Take the square root of a number
///
/// ex: √4
/// ex: √[1 4 9 16]
/// ex: √¯1
(1, Sqrt, MonadicPervasive, ("sqrt", '√')),
/// The sine of a number
/// Get the sine of a number
///
/// ex: ○ 1
///
Expand All @@ -267,11 +267,11 @@ primitive!(
/// You can get a tangent function by [divide]ing the [sine] by the cosine.
/// ex: ÷○+η∶○. 0
(1, Sin, MonadicPervasive, ("sine", '○')),
/// The cosine of a number
/// Get the cosine of a number
(1, Cos, MonadicPervasive),
/// The arcsine of a number
/// Get the arcsine of a number
(1, Asin, MonadicPervasive),
/// The arccosine of a number
/// Get the arccosine of a number
(1, Acos, MonadicPervasive),
/// Round to the nearest integer towards `¯∞`
///
Expand Down Expand Up @@ -424,7 +424,7 @@ primitive!(
/// ex: ⁿ2 [1 2 3]
/// ex: ⁿ [1 2 3] [4 5 6]
(2, Pow, DyadicPervasive, ("power", 'ⁿ')),
/// The based logarithm of a number
/// Get the based logarithm of a number
///
/// The first value is the base, and the second value is the power.
/// ex: ₙ2 8
Expand All @@ -450,14 +450,14 @@ primitive!(
/// [maximum] can be used as a logical OR.
/// ex: ↥,,≤5∶≥8. [6 2 5 9 6 5 0 4]
(2, Max, DyadicPervasive, ("maximum", '↥')),
/// The arctangent of two numbers
/// Take the arctangent of two numbers
///
/// This takes a `y` and `x` argument and returns the angle in radians in the range `(-π, π]`.
/// ex: ∠ 1 0
/// ex: ∠ ¯1 0
/// ex: ∠ √2 √2
(2, Atan, DyadicPervasive, ("atangent", '∠')),
/// The number of rows in an array
/// Get the number of rows in an array
///
/// ex: ⧻5
/// ex: ⧻[]
Expand All @@ -468,7 +468,7 @@ primitive!(
/// ex: ⧻[1_2_3 4_5_6]
/// : ⊢△[1_2_3 4_5_6]
(1, Len, MonadicArray, ("length", '⧻')),
/// The dimensions of an array
/// Get the dimensions of an array
///
/// ex: △5
/// ex: △[]
Expand All @@ -489,14 +489,14 @@ primitive!(
/// : ⇡△[1_2_3 4_5_6]
/// : ⊡⇡△.[1_2_3 4_5_6]
(1, Range, MonadicArray, ("range", '⇡')),
/// The first row of an array
/// Get the first row of an array
///
/// ex: ⊢1_2_3
/// ex: ⊢[1_2 3_4 5_6]
/// ex! ⊢[]
/// ex! ⊢1
(1, First, MonadicArray, ("first", '⊢')),
/// The last element of an array
/// Get the last element of an array
(1, Last, MonadicArray),
/// Reverse the rows of an array
///
Expand Down

0 comments on commit 4a4c3dd

Please sign in to comment.