From 13defcc9f6bd2e0f56a03e63d0d713d5f6b60d6d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Arne=20D=C3=B6ring?= <arne.doering@gmx.net>
Date: Thu, 8 Nov 2018 09:46:12 +0100
Subject: [PATCH] add doc string

---
 lib/std/wordwrap.nim | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/lib/std/wordwrap.nim b/lib/std/wordwrap.nim
index ff33a2ba96..3e3a4609c5 100644
--- a/lib/std/wordwrap.nim
+++ b/lib/std/wordwrap.nim
@@ -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)