summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLaurenz <laurmaedje@gmail.com>2023-05-19 11:40:03 +0200
committerLaurenz <laurmaedje@gmail.com>2023-05-19 11:40:03 +0200
commitaed0f1ce7de424a17a550f1376e7bfd6b8c9e5f6 (patch)
tree3360afa90eeeb363100471f1b6d2ec3522c4efb4
parenta38dd4439e9d433f95ede5c3b3690c03cffa9039 (diff)
Document `both` argument for counters
-rw-r--r--library/src/meta/counter.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/library/src/meta/counter.rs b/library/src/meta/counter.rs
index 0e41a826..46992d38 100644
--- a/library/src/meta/counter.rs
+++ b/library/src/meta/counter.rs
@@ -214,6 +214,12 @@ use crate::prelude::*;
/// If this is omitted, displays the counter with the numbering style for the
/// counted element or with the pattern `{"1.1"}` if no such style exists.
///
+/// - both: boolean (named)
+/// If enabled, displays the current and final top-level count together. Both
+/// can be styled through a single numbering pattern. This is used by the page
+/// numbering property to display the current and total number of pages when a
+/// pattern like `{"1 / 1"}` is given.
+///
/// - returns: content
///
/// ### step()