konevsa/typst
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve clarity regarding location parameter in counter.final() (#1962)

Browse Source
This commit is contained in:
Lukas Löring 2023-08-21 16:53:56 +02:00 committed by GitHub
parent 73999fe823
commit f600515625
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
crates/typst-library/src/meta/counter.rs
View File

@ -267,12 +267,13 @@ use crate::prelude::*;
/// array of integers, even if the counter has just one number.
///
/// - location: location (positional, required)
/// Can be any location. Why is it required then? Typst has to evaluate parts
/// of your code multiple times to determine all counter values. By only
/// allowing this method within [`locate`]($func/locate) calls, the amount of
/// code that can depend on the method's result is reduced. If you could call
/// `final` directly at the top level of a module, the evaluation of the whole
/// module and its exports could depend on the counter's value.
/// Can be an arbitrary location, as its value is irrelevant for the method's
/// return value. Why is it required then? Typst has to evaluate parts of your
/// code multiple times to determine all counter values. By only allowing this
/// method within [`locate`]($func/locate) calls, the amount of code that can
/// depend on the method's result is reduced. If you could call `final`
/// directly at the top level of a module, the evaluation of the whole module
/// and its exports could depend on the counter's value.
///
/// - returns: array
///

7
crates/typst-library/src/meta/query.rs
View File

@ -140,9 +140,10 @@ pub fn query(
/// have an explicit label attached to them. This limitation will be
/// resolved in the future.
target: LocatableSelector,
/// Can be any location. Why is it required then? As noted before, Typst has
/// to evaluate parts of your code multiple times to determine the values of
/// all state. By only allowing this function within
/// Can be an arbitrary location, as its value is irrelevant for the
/// function's return value. Why is it required then? As noted before, Typst
/// has to evaluate parts of your code multiple times to determine the
/// values of all state. By only allowing this function within
/// [`locate`]($func/locate) calls, the amount of code that can depend on
/// the query's result is reduced. If you could call it directly at the top
/// level of a module, the evaluation of the whole module and its exports

15
crates/typst-library/src/meta/state.rs
View File

@ -222,13 +222,14 @@ use crate::prelude::*;
/// Gets the value of the state at the end of the document.
///
/// - location: location (positional, required)
/// Can be any location. Why is it required then? As noted before, Typst has
/// to evaluate parts of your code multiple times to determine the values of
/// all state. By only allowing this method within [`locate`]($func/locate)
/// calls, the amount of code that can depend on the method's result is
/// reduced. If you could call `final` directly at the top level of a module,
/// the evaluation of the whole module and its exports could depend on the
/// state's value.
/// Can be an arbitrary location, as its value is irrelevant for the method's
/// return value. Why is it required then? As noted before, Typst has to
/// evaluate parts of your code multiple times to determine the values of all
/// state. By only allowing this method within [`locate`]($func/locate) calls,
/// the amount of code that can depend on the method's result is reduced. If
/// you could call `final` directly at the top level of a module, the
/// evaluation of the whole module and its exports could depend on the state's
/// value.
///
/// - returns: any
///