From 08ec0ce071fc604f56f29b4fbfb226457345505b Mon Sep 17 00:00:00 2001
From: Federico Ceratto <federico.ceratto@gmail.com>
Date: Fri, 9 Oct 2015 23:26:22 +0100
Subject: [PATCH] Add substituteLog docs

---
 lib/pure/logging.nim | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/lib/pure/logging.nim b/lib/pure/logging.nim
index 4e7f83a9b7..c6c7945359 100644
--- a/lib/pure/logging.nim
+++ b/lib/pure/logging.nim
@@ -93,6 +93,8 @@ type
     PFileLogger: FileLogger, PRollingFileLogger: RollingFileLogger].}
 
 proc substituteLog*(frmt: string, level: Level, args: varargs[string, `$`]): string =
+  ## Format a log message using the ``frmt`` format string, ``level`` and varargs.
+  ## See the module documentation for the format string syntax.
   var msgLen = 0
   for arg in args:
     msgLen += arg.len