From 7b656b3deb5f05e6e56d666622643a5cde8c435a Mon Sep 17 00:00:00 2001 From: bluebear94 Date: Mon, 13 May 2024 08:14:07 -0400 Subject: [PATCH] Revise docs for `place` element (#4105) --- crates/typst/src/layout/place.rs | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/crates/typst/src/layout/place.rs b/crates/typst/src/layout/place.rs index 176eaf472..7d41b0376 100644 --- a/crates/typst/src/layout/place.rs +++ b/crates/typst/src/layout/place.rs @@ -30,8 +30,8 @@ use crate::realize::{Behave, Behaviour}; pub struct PlaceElem { /// Relative to which position in the parent container to place the content. /// - /// Cannot be `{auto}` if `float` is `{false}` and must be either - /// `{auto}`, `{top}`, or `{bottom}` if `float` is `{true}`. + /// - If `float` is `{false}`, then this can be any alignment other than `{auto}`. + /// - If `float` is `{true}`, then this must be `{auto}`, `{top}`, or `{bottom}`. /// /// When an axis of the page is `{auto}` sized, all alignments relative to /// that axis will be ignored, instead, the item will be placed in the @@ -77,9 +77,17 @@ pub struct PlaceElem { /// place(center, dx: amount - 32pt, dy: amount)[A] /// } /// ``` + /// + /// This does not affect the layout of in-flow content. + /// In other words, the placed content is treated as if it + /// were wrapped in a [`move`] element. pub dx: Rel, /// The vertical displacement of the placed content. + /// + /// This does not affect the layout of in-flow content. + /// In other words, the placed content is treated as if it + /// were wrapped in a [`move`] element. pub dy: Rel, /// The content to place.