summaryrefslogtreecommitdiff
path: root/library/src/basics/list.rs
diff options
context:
space:
mode:
authorLaurenz <laurmaedje@gmail.com>2022-12-19 01:16:35 +0100
committerLaurenz <laurmaedje@gmail.com>2022-12-19 01:16:35 +0100
commitb4b022940b908d8fe490b9f4f68bc60dcfb76cd2 (patch)
treebc93a2f51295f97f971466ab87bdd763c0ed6002 /library/src/basics/list.rs
parentba384e5bb6c2455eb431f6e1fcc8b98aca1e9879 (diff)
Syntax and example sections
Diffstat (limited to 'library/src/basics/list.rs')
-rw-r--r--library/src/basics/list.rs10
1 files changed, 10 insertions, 0 deletions
diff --git a/library/src/basics/list.rs b/library/src/basics/list.rs
index c9215a50..15b26169 100644
--- a/library/src/basics/list.rs
+++ b/library/src/basics/list.rs
@@ -8,12 +8,22 @@ use crate::text::{SpaceNode, TextNode};
/// # Parameters
/// - items: Content (positional, variadic)
/// The contents of the list items.
+///
/// - start: NonZeroUsize (named)
/// Which number to start the enumeration with.
+///
/// - tight: bool (named)
/// Makes the list more compact, if enabled. This looks better if the items
/// fit into a single line each.
///
+/// # Example
+/// ```
+/// #show columns.with(2)
+/// #list(tight: true)[Tight][List]
+/// #colbreak()
+/// #list(tight: false)[Wide][List]
+/// ```
+///
/// # Tags
/// - basics
#[func]