summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMalo <57839069+MDLC01@users.noreply.github.com>2025-02-23 12:31:28 +0100
committerGitHub <noreply@github.com>2025-02-23 11:31:28 +0000
commit56f4fa2b4d4d772c5b19c9842419dcc4e078744b (patch)
treec0be1f617afbcd51388d500e253cda0527034114
parent55bc5f4c940c86377f1ffe25b42fdb01a6827358 (diff)
Documentation improvements (#5888)
-rw-r--r--crates/typst-library/src/foundations/symbol.rs1
-rw-r--r--crates/typst-library/src/visualize/color.rs2
-rw-r--r--crates/typst-library/src/visualize/gradient.rs11
-rw-r--r--docs/reference/groups.yml4
4 files changed, 9 insertions, 9 deletions
diff --git a/crates/typst-library/src/foundations/symbol.rs b/crates/typst-library/src/foundations/symbol.rs
index 8a80506f..2c391ee4 100644
--- a/crates/typst-library/src/foundations/symbol.rs
+++ b/crates/typst-library/src/foundations/symbol.rs
@@ -21,6 +21,7 @@ use crate::foundations::{
/// be accessed using [field access notation]($scripting/#fields):
///
/// - General symbols are defined in the [`sym` module]($category/symbols/sym)
+/// and are accessible without the `sym.` prefix in math mode.
/// - Emoji are defined in the [`emoji` module]($category/symbols/emoji)
///
/// Moreover, you can define custom symbols with this type's constructor
diff --git a/crates/typst-library/src/visualize/color.rs b/crates/typst-library/src/visualize/color.rs
index b1431251..20b0f571 100644
--- a/crates/typst-library/src/visualize/color.rs
+++ b/crates/typst-library/src/visualize/color.rs
@@ -130,7 +130,7 @@ static TO_SRGB: LazyLock<qcms::Transform> = LazyLock::new(|| {
///
/// # Predefined color maps
/// Typst also includes a number of preset color maps that can be used for
-/// [gradients]($gradient.linear). These are simply arrays of colors defined in
+/// [gradients]($gradient/#stops). These are simply arrays of colors defined in
/// the module `color.map`.
///
/// ```example
diff --git a/crates/typst-library/src/visualize/gradient.rs b/crates/typst-library/src/visualize/gradient.rs
index d6530dd0..1a723a9f 100644
--- a/crates/typst-library/src/visualize/gradient.rs
+++ b/crates/typst-library/src/visualize/gradient.rs
@@ -70,6 +70,9 @@ use crate::visualize::{Color, ColorSpace, WeightedColor};
/// the offsets when defining a gradient. In this case, Typst will space all
/// stops evenly.
///
+/// Typst predefines color maps that you can use as stops. See the
+/// [`color`]($color/#predefined-color-maps) documentation for more details.
+///
/// # Relativeness
/// The location of the `{0%}` and `{100%}` stops depends on the dimensions
/// of a container. This container can either be the shape that it is being
@@ -157,10 +160,6 @@ use crate::visualize::{Color, ColorSpace, WeightedColor};
/// )
/// ```
///
-/// # Presets
-/// Typst predefines color maps that you can use with your gradients. See the
-/// [`color`]($color/#predefined-color-maps) documentation for more details.
-///
/// # Note on file sizes
///
/// Gradients can be quite large, especially if they have many stops. This is
@@ -288,7 +287,7 @@ impl Gradient {
/// )),
/// )
/// ```
- #[func]
+ #[func(title = "Radial Gradient")]
fn radial(
span: Span,
/// The color [stops](#stops) of the gradient.
@@ -402,7 +401,7 @@ impl Gradient {
/// )),
/// )
/// ```
- #[func]
+ #[func(title = "Conic Gradient")]
pub fn conic(
span: Span,
/// The color [stops](#stops) of the gradient.
diff --git a/docs/reference/groups.yml b/docs/reference/groups.yml
index 961d675d..8fea3a1f 100644
--- a/docs/reference/groups.yml
+++ b/docs/reference/groups.yml
@@ -170,8 +170,8 @@
category: symbols
path: ["emoji"]
details: |
- Named emoji.
+ Named emojis.
For example, `#emoji.face` produces the 😀 emoji. If you frequently use
certain emojis, you can also import them from the `emoji` module (`[#import
- emoji: face]`) to use them without the `#emoji.` prefix.
+ emoji: face]`) to use them without the `emoji.` prefix.