Note that line boundaries also result in breaks

jparise · Feb 4, 2024 · 37b54b4 · 37b54b4
1 parent 30f4ebc
commit 37b54b4
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/vesta/chars.py b/src/vesta/chars.py
@@ -190,6 +190,9 @@ def encode_text(
     cannot be found, the line will be broken at the column limit (potentially
     mid-"word").
 
+    Line boundaries (as determined by :py:meth:`str.splitlines`) appearing in
+    the source string always result in line breaks.
+
     :raises ValueError: if the string contains unsupported characters or codes
 
     >>> encode_text('multiple\\nlines\\nof\\ntext', align="center", valign="middle")