Add substituteLog docs

1 files changed, 2 insertions, 0 deletions

diff --git a/lib/pure/logging.nim b/lib/pure/logging.nim
index 4e7f83a9b..c6c794535 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