1
0
mirror of https://github.com/20kdc/OC-KittenOS.git synced 2024-11-27 04:48:05 +11:00

Fix fmtText documentation

This commit is contained in:
20kdc 2018-04-23 22:39:01 +01:00
parent b75dc370dc
commit 0b7e6557a5

View File

@ -35,15 +35,13 @@ It has two functions for this task:
not reduced. not reduced.
fmtText(text, width): fmtText(text, width):
Formats the given text to a given Formats the given safeTextFormat'd
width in a wrapping fashion. string to a list of lines with a
Returns a series of lines that are given max. width and word wrap, if
padded to the given width. possible (words will be broken by
letter if necessary)
If there are newlines in the text, If there are newlines in the text,
these newlines are respected. these newlines are respected.
If possible, the wrapping is a word
wrap style, but words are broken
if necessary.
If the width is less than 2, then If the width is less than 2, then
this function may fail in various this function may fail in various
ways, up to and including freezes. ways, up to and including freezes.