summaryrefslogtreecommitdiff
path: root/crates
diff options
context:
space:
mode:
authorJohann Birnick <6528009+jbirnick@users.noreply.github.com>2024-11-26 04:35:45 -0800
committerGitHub <noreply@github.com>2024-11-26 12:35:45 +0000
commit580e6811b0281f19fa9c3e438500a9e8bb9b95ef (patch)
tree594e26e1891b5c4a53d1e3da898ee7339e686280 /crates
parent3d7284fc1bb52b4431e3e4742254fd7699f18dc0 (diff)
Docs: note `par.linebreaks` in `text.costs` (#5434)
Diffstat (limited to 'crates')
-rw-r--r--crates/typst-library/src/text/mod.rs4
1 files changed, 3 insertions, 1 deletions
diff --git a/crates/typst-library/src/text/mod.rs b/crates/typst-library/src/text/mod.rs
index 6aeebbba..62c87051 100644
--- a/crates/typst-library/src/text/mod.rs
+++ b/crates/typst-library/src/text/mod.rs
@@ -495,7 +495,9 @@ pub struct TextElem {
///
/// Hyphenation is generally avoided by placing the whole word on the next
/// line, so a higher hyphenation cost can result in awkward justification
- /// spacing.
+ /// spacing. Note: Hyphenation costs will only be applied when the
+ /// [`linebreaks`]($par.linebreaks) are set to "optimized". (For example
+ /// by default implied by [`justify`]($par.justify).)
///
/// Runts are avoided by placing more or fewer words on previous lines, so a
/// higher runt cost can result in more awkward in justification spacing.