diff options
| author | Grégoire Locqueville <glocq@users.noreply.github.com> | 2023-06-07 14:22:43 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-06-07 14:22:43 +0200 |
| commit | 3d3ea9016f339b3753fc7e4c909d6a522a0b7a75 (patch) | |
| tree | 2a2b89e4b51646204d4e1e1e80438f42f7e31887 /library/src/layout | |
| parent | e57f143858dbdc4f90784d422e81ca1cc12871d0 (diff) | |
Clarify markup details in the documentation (#1434)
Diffstat (limited to 'library/src/layout')
| -rw-r--r-- | library/src/layout/enum.rs | 5 | ||||
| -rw-r--r-- | library/src/layout/list.rs | 5 | ||||
| -rw-r--r-- | library/src/layout/terms.rs | 5 |
3 files changed, 15 insertions, 0 deletions
diff --git a/library/src/layout/enum.rs b/library/src/layout/enum.rs index 62f4c351..2204b284 100644 --- a/library/src/layout/enum.rs +++ b/library/src/layout/enum.rs @@ -72,6 +72,11 @@ pub struct EnumElem { /// [leading]($func/par.leading) instead. This makes the enumeration more /// compact, which can look better if the items are short. /// + /// In markup mode, the value of this parameter is determined based on + /// whether items are separated with a blank line. If items directly follow + /// each other, this is set to `{true}`; if items are separated by a blank + /// line, this is set to `{false}`. + /// /// ```example /// + If an enum has a lot of text, and /// maybe other inline content, it diff --git a/library/src/layout/list.rs b/library/src/layout/list.rs index b308c2ce..a11b019f 100644 --- a/library/src/layout/list.rs +++ b/library/src/layout/list.rs @@ -47,6 +47,11 @@ pub struct ListElem { /// [leading]($func/par.leading) instead. This makes the list more compact, /// which can look better if the items are short. /// + /// In markup mode, the value of this parameter is determined based on + /// whether items are separated with a blank line. If items directly follow + /// each other, this is set to `{true}`; if items are separated by a blank + /// line, this is set to `{false}`. + /// /// ```example /// - If a list has a lot of text, and /// maybe other inline content, it diff --git a/library/src/layout/terms.rs b/library/src/layout/terms.rs index 0cfe98d9..8b8a7223 100644 --- a/library/src/layout/terms.rs +++ b/library/src/layout/terms.rs @@ -32,6 +32,11 @@ pub struct TermsElem { /// [leading]($func/par.leading) instead. This makes the term list more /// compact, which can look better if the items are short. /// + /// In markup mode, the value of this parameter is determined based on + /// whether items are separated with a blank line. If items directly follow + /// each other, this is set to `{true}`; if items are separated by a blank + /// line, this is set to `{false}`. + /// /// ```example /// / Fact: If a term list has a lot /// of text, and maybe other inline |