caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-07-18 10:02:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

Slightly improve selector docs (#6544)

Browse Source
This commit is contained in:
Robin 2025-07-16 18:15:49 +02:00 committed by GitHub
parent 7897e86bcc
commit 5661c20580
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
crates/typst-library/src/foundations/selector.rs
View File

@ -37,13 +37,12 @@ pub use crate::__select_where as select_where;
/// A filter for selecting elements within the document. /// A filter for selecting elements within the document.
/// ///
/// You can construct a selector in the following ways: /// To construct a selector you can:
/// - you can use an element [function] /// - use an element [function]
/// - you can filter for an element function with /// - filter for an element function with [specific fields]($function.where)
/// [specific fields]($function.where) /// - use a [string]($str) or [regular expression]($regex)
/// - you can use a [string]($str) or [regular expression]($regex) /// - use a [`{<label>}`]($label)
/// - you can use a [`{<label>}`]($label) /// - use a [`location`]
/// - you can use a [`location`]
/// - call the [`selector`] constructor to convert any of the above types into a /// - call the [`selector`] constructor to convert any of the above types into a
/// selector value and use the methods below to refine it /// selector value and use the methods below to refine it
/// ///
@ -148,7 +147,9 @@ impl Selector {
impl Selector { impl Selector {
/// Turns a value into a selector. The following values are accepted: /// Turns a value into a selector. The following values are accepted:
/// - An element function like a `heading` or `figure`. /// - An element function like a `heading` or `figure`.
/// - A [string]($str) or [regular expression]($regex).
/// - A `{<label>}`. /// - A `{<label>}`.
/// - A [`location`].
/// - A more complex selector like `{heading.where(level: 1)}`. /// - A more complex selector like `{heading.where(level: 1)}`.
#[func(constructor)] #[func(constructor)]
pub fn construct( pub fn construct(