mirror of
https://github.com/nim-lang/Nim.git
synced 2026-06-06 20:04:18 +00:00
add doc string
This commit is contained in:
committed by
Andreas Rumpf
parent
1d7c36bd8c
commit
13defcc9f6
@@ -3,6 +3,10 @@ import unicode
|
||||
proc wordWrap*(s: string, maxLineWidth = 80,
|
||||
splitLongWords = true,
|
||||
newLine = "\n"): string =
|
||||
## This function breaks all words that reach over `maxLineWidth`
|
||||
## measured in number of runes. When `splitLongWords` is `true`
|
||||
## words that are longer than `maxLineWidth` are splitted. Multiple spaces and newlines are converted to a single space. All
|
||||
## whitespace is treated equally. Non-breaking whitespace is ignored.
|
||||
|
||||
var currentWordLength: int = 0
|
||||
var currentWord: string = newStringOfCap(32)
|
||||
|
||||
Reference in New Issue
Block a user