Clarify markup details in the documentation (#1434)

This commit is contained in:
Grégoire Locqueville 2023-06-07 14:22:43 +02:00 committed by GitHub
parent e57f143858
commit 3d3ea9016f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 18 additions and 0 deletions

View File

@ -72,6 +72,11 @@ pub struct EnumElem {
/// [leading]($func/par.leading) instead. This makes the enumeration more /// [leading]($func/par.leading) instead. This makes the enumeration more
/// compact, which can look better if the items are short. /// 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 /// ```example
/// + If an enum has a lot of text, and /// + If an enum has a lot of text, and
/// maybe other inline content, it /// maybe other inline content, it

View File

@ -47,6 +47,11 @@ pub struct ListElem {
/// [leading]($func/par.leading) instead. This makes the list more compact, /// [leading]($func/par.leading) instead. This makes the list more compact,
/// which can look better if the items are short. /// 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 /// ```example
/// - If a list has a lot of text, and /// - If a list has a lot of text, and
/// maybe other inline content, it /// maybe other inline content, it

View File

@ -32,6 +32,11 @@ pub struct TermsElem {
/// [leading]($func/par.leading) instead. This makes the term list more /// [leading]($func/par.leading) instead. This makes the term list more
/// compact, which can look better if the items are short. /// 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 /// ```example
/// / Fact: If a term list has a lot /// / Fact: If a term list has a lot
/// of text, and maybe other inline /// of text, and maybe other inline

View File

@ -63,6 +63,9 @@ pub struct RawElem {
/// Whether the raw text is displayed as a separate block. /// Whether the raw text is displayed as a separate block.
/// ///
/// In markup mode, using one-backtick notation makes this `{false}`,
/// whereas using three-backtick notation makes it `{true}`.
///
/// ````example /// ````example
/// // Display inline code in a small box /// // Display inline code in a small box
/// // that retains the correct baseline. /// // that retains the correct baseline.