From b96b7b7ee12a5d1c8e8c24c95b58b7ca03cec44b Mon Sep 17 00:00:00 2001 From: MALO <57839069+MDLC01@users.noreply.github.com> Date: Sat, 24 Jun 2023 14:33:17 +0200 Subject: Use third person in documentation (#1560) --- library/src/math/accent.rs | 2 +- library/src/math/attach.rs | 4 ++-- library/src/math/cancel.rs | 6 +++--- library/src/math/delimited.rs | 10 +++++----- library/src/math/style.rs | 4 ++-- 5 files changed, 13 insertions(+), 13 deletions(-) (limited to 'library/src/math') diff --git a/library/src/math/accent.rs b/library/src/math/accent.rs index 27397911..d1bee198 100644 --- a/library/src/math/accent.rs +++ b/library/src/math/accent.rs @@ -3,7 +3,7 @@ use super::*; /// How much the accent can be shorter than the base. const ACCENT_SHORT_FALL: Em = Em::new(0.5); -/// Attach an accent to a base. +/// Attaches an accent to a base. /// /// ## Example { #example } /// ```example diff --git a/library/src/math/attach.rs b/library/src/math/attach.rs index 340dd21e..158e5f0d 100644 --- a/library/src/math/attach.rs +++ b/library/src/math/attach.rs @@ -84,7 +84,7 @@ impl LayoutMath for AttachElem { } } -/// Force a base to display attachments as scripts. +/// Forces a base to display attachments as scripts. /// /// ## Example { #example } /// ```example @@ -110,7 +110,7 @@ impl LayoutMath for ScriptsElem { } } -/// Force a base to display attachments as limits. +/// Forces a base to display attachments as limits. /// /// ## Example { #example } /// ```example diff --git a/library/src/math/cancel.rs b/library/src/math/cancel.rs index 643eb9eb..f576a727 100644 --- a/library/src/math/cancel.rs +++ b/library/src/math/cancel.rs @@ -2,7 +2,7 @@ use super::*; /// Displays a diagonal line over a part of an equation. /// -/// This is commonly used to show the eliminiation of a term. +/// This is commonly used to show the elimination of a term. /// /// ## Example { #example } /// ```example @@ -53,8 +53,8 @@ pub struct CancelElem { #[default(false)] pub cross: bool, - /// Rotate the cancel line by a certain angle. See the - /// [line's documentation]($func/line.angle) for more details. + /// How to rotate the cancel line. See the [line's + /// documentation]($func/line.angle) for more details. /// /// ```example /// >>> #set page(width: 140pt) diff --git a/library/src/math/delimited.rs b/library/src/math/delimited.rs index 08d18a5e..99cd6c33 100644 --- a/library/src/math/delimited.rs +++ b/library/src/math/delimited.rs @@ -104,7 +104,7 @@ fn scale( } } -/// Floor an expression. +/// Floors an expression. /// /// ## Example { #example } /// ```example @@ -121,7 +121,7 @@ pub fn floor( delimited(body, '⌊', '⌋') } -/// Ceil an expression. +/// Ceils an expression. /// /// ## Example { #example } /// ```example @@ -138,7 +138,7 @@ pub fn ceil( delimited(body, '⌈', '⌉') } -/// Round an expression. +/// Rounds an expression. /// /// ## Example { #example } /// ```example @@ -155,7 +155,7 @@ pub fn round( delimited(body, '⌊', '⌉') } -/// Take the absolute value of an expression. +/// Takes the absolute value of an expression. /// /// ## Example { #example } /// ```example @@ -173,7 +173,7 @@ pub fn abs( delimited(body, '|', '|') } -/// Take the norm of an expression. +/// Takes the norm of an expression. /// /// ## Example { #example } /// ```example diff --git a/library/src/math/style.rs b/library/src/math/style.rs index b6549ee9..235770db 100644 --- a/library/src/math/style.rs +++ b/library/src/math/style.rs @@ -153,11 +153,11 @@ pub fn bb( /// Forced display style in math. /// -/// This is the normal size for display equations. +/// This is the normal size for block equations. /// /// ## Example { #example } /// ```example -/// $sum_i x_i/2 = display(sum_i x/2)$ +/// $sum_i x_i/2 = display(sum_i x_i/2)$ /// ``` /// /// Display: Display Size -- cgit v1.2.3