From a583d686b46b25747fd7b946bb7debf10bde0055 Mon Sep 17 00:00:00 2001
From: Dominik Picheta <dominikpicheta@googlemail.com>
Date: Sat, 18 Nov 2017 11:26:18 +0000
Subject: [PATCH] Update docs of cookies.parseCookies. Closes #5721.

---
 lib/pure/cookies.nim | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/lib/pure/cookies.nim b/lib/pure/cookies.nim
index 7d850798cb..07b37c7d48 100644
--- a/lib/pure/cookies.nim
+++ b/lib/pure/cookies.nim
@@ -13,6 +13,15 @@ import strtabs, times
 
 proc parseCookies*(s: string): StringTableRef =
   ## parses cookies into a string table.
+  ##
+  ## The proc is meant to parse the Cookie header set by a client, not the
+  ## "Set-Cookie" header set by servers.
+  ##
+  ## Example:
+  ##
+  ## .. code-block::Nim
+  ##     doAssert parseCookies("a=1; foo=bar") == {"a": 1, "foo": "bar"}.newStringTable
+
   result = newStringTable(modeCaseInsensitive)
   var i = 0
   while true: