caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-05-21 12:35:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

Clarify syntactical difference in label function docs (#4957)

Browse Source
This commit is contained in:
Max 2024-09-26 08:39:39 +00:00 committed by GitHub
parent 58c71ade2f
commit 79558f44a0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
crates/typst/src/foundations/label.rs
View File

@ -29,6 +29,16 @@ use crate::utils::PicoStr;
/// its name in angle brackets. This works both in markup and code. A label's /// its name in angle brackets. This works both in markup and code. A label's
/// name can contain letters, numbers, `_`, `-`, `:`, and `.`. /// name can contain letters, numbers, `_`, `-`, `:`, and `.`.
/// ///
/// Note that there is a syntactical difference when using the dedicated syntax
/// for this function. In the code below, the `[<a>]` terminates the heading and
/// thus attaches to the heading itself, whereas the `[#label("b")]` is part of
/// the heading and thus attaches to the heading's text.
///
/// ```typ
/// = Intro <a> // Equivalent to `#heading[Intro] <a>`.
/// = Concl #label("b") // Equivalent to `#heading[Concl #label("b")]`.
/// ```
///
/// Currently, labels can only be attached to elements in markup mode, not in /// Currently, labels can only be attached to elements in markup mode, not in
/// code mode. This might change in the future. /// code mode. This might change in the future.
#[ty(scope, cast)] #[ty(scope, cast)]