diff options
| author | bluebear94 <uruwi@protonmail.com> | 2024-05-13 08:14:07 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-13 12:14:07 +0000 |
| commit | 7b656b3deb5f05e6e56d666622643a5cde8c435a (patch) | |
| tree | 2a9f2b84c612f49a5a0b8ed9def12e53f514b614 | |
| parent | e8ee15277dbd8b5b5373c202de2a6a9e8d18ce16 (diff) | |
Revise docs for `place` element (#4105)
| -rw-r--r-- | crates/typst/src/layout/place.rs | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/crates/typst/src/layout/place.rs b/crates/typst/src/layout/place.rs index 176eaf47..7d41b037 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<Length>, /// 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<Length>, /// The content to place. |