jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add doc string

Browse source
This commit is contained in:
Arne Döring 2018-11-08 09:46:12 +01:00 • committed by Andreas Rumpf
commit 13defcc9f6
1 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lib/std/wordwrap.nim
View file

@ -3,6 +3,10 @@ import unicode
proc wordWrap*(s: string, maxLineWidth = 80, proc wordWrap*(s: string, maxLineWidth = 80,
splitLongWords = true, splitLongWords = true,
newLine = "\n"): string = 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 currentWordLength: int = 0
var currentWord: string = newStringOfCap(32) var currentWord: string = newStringOfCap(32)