From 8fbfa594e072aba384becaf5f4bd358bcc2ebc68 Mon Sep 17 00:00:00 2001 From: Martin Haug Date: Sun, 29 Jan 2023 12:43:44 +0100 Subject: [PATCH] Update docs so that the reference builds again --- library/src/compute/foundations.rs | 8 ++++---- library/src/layout/transform.rs | 2 +- library/src/math/lr.rs | 2 +- library/src/math/mod.rs | 9 ++++----- library/src/math/style.rs | 2 +- 5 files changed, 11 insertions(+), 12 deletions(-) diff --git a/library/src/compute/foundations.rs b/library/src/compute/foundations.rs index a5d0586b..c51d5766 100644 --- a/library/src/compute/foundations.rs +++ b/library/src/compute/foundations.rs @@ -41,10 +41,10 @@ pub fn type_(args: &mut Args) -> SourceResult { /// /// ## Example /// ``` -/// { none } vs #repr(none) \ -/// { "hello" } vs #repr("hello") \ -/// { (1, 2) } vs #repr((1, 2)) \ -/// { [*Hi*] } vs #repr([*Hi*]) +/// #{ none } vs #repr(none) \ +/// #{ "hello" } vs #repr("hello") \ +/// #{ (1, 2) } vs #repr((1, 2)) \ +/// #{ [*Hi*] } vs #repr([*Hi*]) /// ``` /// /// ## Parameters diff --git a/library/src/layout/transform.rs b/library/src/layout/transform.rs index c843ad4e..09b4350d 100644 --- a/library/src/layout/transform.rs +++ b/library/src/layout/transform.rs @@ -96,7 +96,7 @@ impl Inline for MoveNode {} /// /// ## Example /// ``` -/// { +/// #{ /// range(16) /// .map(i => rotate(24deg * i)[X]) /// .join(h(1fr)) diff --git a/library/src/math/lr.rs b/library/src/math/lr.rs index a33810df..30ff532a 100644 --- a/library/src/math/lr.rs +++ b/library/src/math/lr.rs @@ -12,7 +12,7 @@ pub(super) const DELIM_SHORT_FALL: Em = Em::new(0.1); /// ## Example /// ``` /// $ lr(]a, b/2]) $ -/// $ lr(]sum_(x=1)^n] x, #size: 50%) $ +/// $ lr(]sum_(x=1)^n] x, size: #50%) $ /// ``` /// /// ## Parameters diff --git a/library/src/math/mod.rs b/library/src/math/mod.rs index 2d914c31..f1bcd8f4 100644 --- a/library/src/math/mod.rs +++ b/library/src/math/mod.rs @@ -117,7 +117,8 @@ pub fn module(sym: &Module) -> Module { /// however, are interpreted as variables, symbols or functions. To display /// multiple letters verbatim, you can place them into quotes. Math mode also /// supports extra shorthands to easily type various arrows and other symbols. -/// The page on the [`symbol`](@symbol) function lists all of them. +/// The [text](/docs/reference/text/) and [math](/docs/reference/math/) sections +/// list all of them. /// /// When a variable and a symbol share the same name, the variable is preferred. /// To force the symbol, surround it with colons. To access a variable with a @@ -145,11 +146,9 @@ pub fn module(sym: &Module) -> Module { /// ``` /// /// ## Parameters -/// - body: Content (positional, required) -/// The contents of the formula. +/// - body: Content (positional, required) The contents of the formula. /// -/// - block: bool (named) -/// Whether the formula is displayed as a separate block. +/// - block: bool (named) Whether the formula is displayed as a separate block. /// /// ## Category /// math diff --git a/library/src/math/style.rs b/library/src/math/style.rs index d10230f9..d408b532 100644 --- a/library/src/math/style.rs +++ b/library/src/math/style.rs @@ -243,7 +243,7 @@ impl LayoutMath for MonoNode { /// Blackboard bold (double-struck) font style in math. /// /// For uppercase latin letters, blackboard bold is additionally available -/// through [symmie symbols](@symbol) of the form `NN` and `RR`. +/// through [symbols](/docs/reference/math/) of the form `NN` and `RR`. /// /// ## Example /// ```