コメントへの対応と余分な改行の削除

Author: sbtseiji

crates/typst-library/src/foundations/calc.rs

@@ -58,7 +58,7 @@ pub fn module() -> Module {
     Module::new("calc", scope)
 }
 
-/// 数値の絶対値。
+/// 絶対値。
 ///
 /// ```example
 /// #calc.abs(-5) \
@@ -89,7 +89,7 @@ cast! {
     v: Decimal => Self(Value::Decimal(v.abs()))
 }
 
-/// 数値のべき乗。
+/// べき乗。
 ///
 /// ```example
 /// #calc.pow(2, 3) \
@@ -180,7 +180,7 @@ pub fn exp(
     Ok(result)
 }
 
-/// 値の平方根。
+/// 平方根。
 ///
 /// ```example
 /// #calc.sqrt(16) \
@@ -197,7 +197,7 @@ pub fn sqrt(
     Ok(value.v.float().sqrt())
 }
 
-/// 数値のn乗根。
+/// n乗根。
 ///
 /// 負の値の場合、nは奇数でなければなりません。
 ///
@@ -207,9 +207,9 @@ pub fn sqrt(
 /// ```
 #[func]
 pub fn root(
-    /// 根号で表現される式
+    /// 根を取る対象の式。
     radicand: f64,
-    /// 根号の指数
+    /// 被開方数の何乗根を取るか。
     index: Spanned<i64>,
 ) -> SourceResult<f64> {
     if index.v == 0 {
@@ -228,7 +228,7 @@ pub fn root(
     }
 }
 
-/// 角度のサイン（正弦）。
+/// サイン（正弦）の計算。
 ///
 /// 整数または浮動小数点数で呼び出された場合、それらはラジアンとして解釈されます。
 ///
@@ -248,7 +248,7 @@ pub fn sin(
     }
 }
 
-/// 角度のコサイン（余弦）。
+/// コサイン（余弦）の計算。
 ///
 /// 整数または浮動小数点数で呼び出された場合、それらはラジアンとして解釈されます。
 ///
@@ -268,9 +268,9 @@ pub fn cos(
     }
 }
 
-/// 角度のタンジェント（正接）。
+/// タンジェント（正接）の計算。
 ///
-/// 整数または浮動小数点数で呼び出された場合、それらはラジアンとして解釈されます。
+/// 整数または浮動小数点数に対して呼び出された場合、それらはラジアンとして解釈されます。
 ///
 /// ```example
 /// #calc.tan(1.5) \
@@ -288,7 +288,7 @@ pub fn tan(
     }
 }
 
-/// 数値のアークサイン（逆正弦）。
+/// アークサイン（逆正弦）の計算。
 ///
 /// ```example
 /// #calc.asin(0) \
@@ -306,7 +306,7 @@ pub fn asin(
     Ok(Angle::rad(val.asin()))
 }
 
-/// 数値のアークコサイン（逆余弦）。
+/// アークコサイン（逆余弦）の計算。
 ///
 /// ```example
 /// #calc.acos(0) \
@@ -324,7 +324,7 @@ pub fn acos(
     Ok(Angle::rad(val.acos()))
 }
 
-/// 数値のアークタンジェント（逆正接）。
+/// アークタンジェント（逆正接）の計算。
 ///
 /// ```example
 /// #calc.atan(0) \
@@ -338,7 +338,7 @@ pub fn atan(
     Angle::rad(value.float().atan())
 }
 
-/// 座標の四象限アークタンジェント。
+/// 四象限アークタンジェントの計算。
 ///
 /// 引数の順序は`(y, x)`ではなく`(x, y)`です。
 ///
@@ -348,51 +348,51 @@ pub fn atan(
 /// ```
 #[func(title = "Four-quadrant Arctangent")]
 pub fn atan2(
-    /// X座標
+    /// X座標。
     x: Num,
-    /// Y座標
+    /// Y座標。
     y: Num,
 ) -> Angle {
     Angle::rad(f64::atan2(y.float(), x.float()))
 }
 
-/// 双曲線角の双曲線サイン。
+/// ハイパーボリックサイン（双曲線正弦）を計算。
 ///
 /// ```example
 /// #calc.sinh(0) \
 /// #calc.sinh(1.5)
 /// ```
 #[func(title = "Hyperbolic Sine")]
 pub fn sinh(
-    /// 双曲線サインを計算する双曲線角。
+    /// ハイパーボリックサインを計算する双曲角。
     value: f64,
 ) -> f64 {
     value.sinh()
 }
 
-/// 双曲線角の双曲線コサイン。
+/// ハイパーボリックコサイン（双曲線余弦）を計算。
 ///
 /// ```example
 /// #calc.cosh(0) \
 /// #calc.cosh(1.5)
 /// ```
 #[func(title = "Hyperbolic Cosine")]
 pub fn cosh(
-    /// 双曲線コサインを計算する双曲線角。
+    /// ハイパーボリックコサインを計算する双曲角。
     value: f64,
 ) -> f64 {
     value.cosh()
 }
 
-/// 双曲線角の双曲線タンジェント。
+/// ハイパーボリックタンジェント（双曲線正接）を計算。
 ///
 /// ```example
 /// #calc.tanh(0) \
 /// #calc.tanh(1.5)
 /// ```
 #[func(title = "Hyperbolic Tangent")]
 pub fn tanh(
-    /// 双曲線タンジェントを計算する双曲線角。
+    /// ハイパーボリックタンジェントを計算する双曲角。
     value: f64,
 ) -> f64 {
     value.tanh()
@@ -480,8 +480,7 @@ pub fn fact(
 
 /// 順列の計算。
 ///
-/// 順列、つまり、`n`個の項目から`k`個を、順序を区別して選択する
-/// 組み合わせの数を返します。
+/// 順列、つまり、`n`個の項目から`k`個を、順序を区別して選択する組み合わせの数を返します。
 ///
 /// ```example
 /// $ "perm"(n, k) &= n!/((n - k)!) \
@@ -528,7 +527,7 @@ fn fact_impl(start: u64, end: u64) -> Option<i64> {
 /// ```
 #[func(title = "Binomial")]
 pub fn binom(
-    /// 全体の数。0または正の値である必要があります。
+    /// 上側の係数。0または正の値である必要があります。
     n: u64,
     /// 下側の係数。0または正の値である必要があります。
     k: u64,
@@ -606,9 +605,7 @@ pub fn lcm(
 ///
 /// もしその値がすでに整数であれば、そのまま返されます。
 ///
-/// この関数はつねに整数値($int)を返し、結果となる[`float`]や[`decimal`]が
-/// 64ビット符号つき整数の最大値より大きい、または最小値より小さい場合は
-/// エラーとなります。
+/// この関数はつねに整数値($int)を返し、結果となる[`float`]や[`decimal`]が64ビット符号付き整数の最大値より大きい、または最小値より小さい場合はエラーとなります。
 ///
 /// ```example
 /// #calc.floor(500.1)
@@ -633,9 +630,7 @@ pub fn floor(
 ///
 /// もしその値がすでに整数であれば、そのまま返されます。
 ///
-/// この関数はつねに整数値($int)を返し、結果となる[`float`]や[`decimal`]が
-/// 64ビット符号つき整数の最大値より大きい、または最小値より小さい場合は
-/// エラーとなります。
+/// この関数はつねに整数値($int)を返し、結果となる[`float`]や[`decimal`]が64ビット符号付き整数の最大値より大きい、または最小値より小さい場合はエラーとなります。
 ///
 /// ```example
 /// #calc.ceil(500.1)
@@ -660,9 +655,7 @@ pub fn ceil(
 ///
 /// もしその値がすでに整数であれば、そのまま返されます。
 ///
-/// この関数はつねに整数値($int)を返し、結果となる[`float`]や[`decimal`]が
-/// 64ビット符号つき整数の最大値より大きい、または最小値より小さい場合は
-/// エラーとなります。
+/// この関数はつねに整数値($int)を返し、結果となる[`float`]や[`decimal`]が64ビット符号付き整数の最大値より大きい、または最小値より小さい場合はエラーとなります。
 ///
 /// ```example
 /// #calc.trunc(15.9)
@@ -685,7 +678,7 @@ pub fn trunc(
 
 /// 数値の小数部分を切り出し。
 ///
-/// もしその値が整数であれば、「0」を返します。
+/// もしその値が整数であれば、`0`を返します。
 ///
 /// ```example
 /// #calc.fract(-3.1)
@@ -708,18 +701,12 @@ pub fn fract(
 ///
 /// オプションで、小数点以下の桁数を指定することも可能です。
 ///
-/// 指定する桁数が負の値の場合、その絶対値が小数点より左側で切り捨てる
-/// 有効整数桁数を示します。
+/// 指定する桁数が負の値の場合、その絶対値が小数点より左側で切り捨てる有効整数桁数を示します。
 ///
-/// この関数は、演算対象と同じ型の値を返します。つまり、[`float`]に`round`を
-/// 適用すると`float`が、[`decimal`]に適用すると`decimal`が返されます。
-/// 関数の出力を明示的に[`int`]にすることも可能ですが、その`float`や`decimal`が
-/// 64ビット符号つき整数の最大値より大きい場合、または最小値より小さい場合はエラー
-/// となることに注意してください。
+/// この関数は、演算対象と同じ型の値を返します。つまり、[`float`]に`round`を適用すると`float`が、[`decimal`]に適用すると`decimal`が返されます。
+/// 関数の出力を明示的に[`int`]にすることも可能ですが、その`float`や`decimal`が64ビット符号付き整数の最大値より大きい場合、または最小値より小さい場合はエラーとなることに注意してください。
 ///
-/// さらに、この関数は、最大または最小の整数や`decimal`を超えて丸めようとすると
-/// エラーになる場合があります。数値が`float`の場合、そのような試みは、最大値や
-/// 最小値に対してそれぞれ`{float.inf}`と`{-float.inf}`を返します。
+/// さらに、この関数は、整数や`decimal`の最大値または最小値を超えて丸めようとするとエラーになる場合があります。数値が`float`の場合、そのような試みは、最大値や最小値に対してそれぞれ`{float.inf}`と`{-float.inf}`を返します。
 /// ```example
 /// #calc.round(3.1415, digits: 2)
 /// #assert(calc.round(3) == 3)
@@ -794,7 +781,7 @@ pub fn clamp(
         .at(span)
 }
 
-/// 一連の値の最小値を決定
+/// 一連の値の最小値を決定。
 ///
 /// ```example
 /// #calc.min(1, -3, -5, 20, 3, 6) \
@@ -810,7 +797,7 @@ pub fn min(
     minmax(span, values, Ordering::Less)
 }
 
-/// 一連の値の最大値を決定
+/// 一連の値の最大値を決定。
 ///
 /// ```example
 /// #calc.max(1, -3, -5, 20, 3, 6) \
@@ -847,7 +834,7 @@ fn minmax(
     Ok(extremum)
 }
 
-/// 整数値が偶数かどうかを判断。
+/// 整数値が偶数かどうかを判定。
 ///
 /// ```example
 /// #calc.even(4) \
@@ -881,8 +868,7 @@ pub fn odd(
 ///
 /// `calc.rem(x, y)`の値は常に`x`と同じ符号を持ち、`y`よりも小さい絶対値になります。
 ///
-/// [`decimal`]が入力され、被除数が除数に比べて絶対値が小さすぎる場合はエラーになる
-/// ことがあります。
+/// [`decimal`]が入力され、被除数が除数に比べて絶対値が小さすぎる場合はエラーになることがあります。
 ///
 /// ```example
 /// #calc.rem(7, 3) \
@@ -918,8 +904,7 @@ pub fn rem(
 
 /// 2つの数値のユークリッド除算を実行。
 ///
-/// この計算の結果は、商を被除数が除数の`{n}`倍以上になる整数`{n}`
-/// に丸めた値です。
+/// この計算の結果は、商を被除数が除数の`{n}`倍以上になる整数`{n}`に丸めた値です。
 ///
 /// ```example
 /// #calc.div-euclid(7, 3) \
@@ -956,12 +941,10 @@ pub fn div_euclid(
 
 /// 除算の最小の非負剰余を計算。
 ///
-/// 警告：浮動小数点数の丸め誤差により、被除数が除数よりも極端に小さく、 
-/// かつ負の値である場合、剰余が除数の絶対値と等しくなる可能性があります。
+/// 警告：浮動小数点数の丸め誤差により、被除数が除数よりも極端に小さく、かつ負の値である場合、剰余が除数の絶対値と等しくなる可能性があります。
 /// これは浮動小数点数の入力にのみ当てはまります。
 ///
-/// また、[`decimal`]を入力した場合、被除数が除数に比べて桁違いに小さい
-/// 場合はエラーとなることがあります。
+/// また、[`decimal`]を入力した場合、被除数が除数に比べて桁違いに小さい場合はエラーとなることがあります。
 ///
 /// ```example
 /// #calc.rem-euclid(7, 3) \
@@ -998,9 +981,7 @@ pub fn rem_euclid(
 
 /// 2つの数値の商（切り捨て除算）を計算します。
 ///
-/// この関数はつねに[整数値]($int)を返し、結果となる[`float`]や
-/// [`decimal`]が64ビット符号つき整数の最大値より大きい、
-/// または最小値より小さい場合はエラーとなります。
+/// この関数はつねに[整数値]($int)を返し、結果となる[`float`]や[`decimal`]が64ビット符号付き整数の最大値より大きい、または最小値より小さい場合はエラーとなることに注意してください。
 ///
 /// ```example
 /// $ "quo"(a, b) &= floor(a/b) \