caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-08-14 15:17:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation

Browse Source
This commit is contained in:
Malo 2024-12-25 16:45:34 +01:00
parent 0aa385d584
commit 9ce4b2ff4a
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
crates/typst-library/src/foundations/array.rs
View File

@ -838,14 +838,16 @@ impl Array {
/// The callsite span.
span: Span,
/// If given, applies this function to the elements in the array to
/// determine the keys to sort by.
/// determine the keys to sort by. Mutually exclusive with `compare`.
#[named]
key: Option<Func>,
/// If given, uses this function to compare elements in the array.
/// Mutually exclusive with `key`.
///
/// This function should return an integer, whose sign is
/// used to determine the relative order of two given
/// elements.
/// This function should return an integer, whose sign is used to
/// determine the relative order of two given elements: Negative if the
/// first element is smaller, positive if the second element is smaller.
/// If `{0}` is returned, the order of the elements is not modified.
#[named]
compare: Option<Func>,
) -> SourceResult<Array> {