Documentation fixes

This commit is contained in:
Laurenz 2023-02-26 23:07:50 +01:00
parent 7597b99789
commit aa8a5bf42f
5 changed files with 11 additions and 15 deletions

View File

@ -680,11 +680,9 @@ Returns the values of the dictionary as an array in key-order.
- returns: array
### pairs()
Call a function for each key-value pair and return the results in an array.
Returns the keys and values of the dictionary as an array of pairs. Each pair is
represented as an array of length two.
- mapper: function (positional, required)
The function to apply to each pair. Gets passed the key and value as two
separate arguments.
- returns: array
### remove()

View File

@ -86,8 +86,8 @@ pub fn panic(args: &mut Args) -> SourceResult<Value> {
/// produce any output in the document.
///
/// ## Example
/// ```example
/// #assert(1 < 2, message: "one is")
/// ```typ
/// #assert(1 < 2, message: "math broke")
/// ```
///
/// ## Parameters
@ -119,9 +119,9 @@ pub fn assert(args: &mut Args) -> SourceResult<Value> {
///
/// ## Example
/// ```example
/// #eval("1 + 2") \
/// #eval("[*Strong text*]") \
/// #eval("(1, 2, 3)").len()
/// #eval("1 + 1") \
/// #eval("(1, 2, 3, 4)").len() \
/// #eval("[*Strong text*]")
/// ```
///
/// ## Parameters

View File

@ -11,20 +11,19 @@ use crate::text::TextNode;
/// ## Example
/// ```example
/// - *Content*
/// - Basics
/// - Text
/// - Math
/// - Layout
/// - Visualize
/// - Meta
/// - Symbols
///
/// - *Compute*
/// #list(
/// [Foundations],
/// [Calculate],
/// [Create],
/// [Construct],
/// [Data Loading],
/// [Utility],
/// )
/// ```
///

View File

@ -32,7 +32,7 @@ use crate::text::{
/// integer value of $n > 2$.
///
/// Without loss of generality,
/// let a be the smallest of the
/// let $a$ be the smallest of the
/// three integers. Then, we ...
/// ```
///

View File

@ -312,8 +312,7 @@ impl Case {
/// Display text in small capitals.
///
/// _Note:_ This enables the OpenType `smcp` feature for the font. Not all fonts
/// support this feature (including Typst's current default font,
/// unfortunately). Sometimes smallcaps are part of a dedicated font and
/// support this feature. Sometimes smallcaps are part of a dedicated font and
/// sometimes they are not available at all. In the future, this function will
/// support selecting a dedicated smallcaps font as well as synthesizing
/// smallcaps from normal letters, but this is not yet implemented.