summary refs log tree commit diff stats
path: root/lib/pure
diff options
context:
space:
mode:
authorflywind <xzsflywind@gmail.com>2021-04-07 04:08:59 +0800
committerGitHub <noreply@github.com>2021-04-06 22:08:59 +0200
commit34c1c631bb61e8a7dde923c73a2eecbd9d96345a (patch)
tree5bfd92e85fb55662c03f6fe01e974e11c7ad1003 /lib/pure
parent6ab58168661b27778dd6bd64bedf70a7889f5aa0 (diff)
downloadNim-34c1c631bb61e8a7dde923c73a2eecbd9d96345a.tar.gz
close #4451 (#17627)
Diffstat (limited to 'lib/pure')
-rw-r--r--lib/pure/nimprof.nim3
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/pure/nimprof.nim b/lib/pure/nimprof.nim
index 721ae35c3..3b1f703e3 100644
--- a/lib/pure/nimprof.nim
+++ b/lib/pure/nimprof.nim
@@ -9,7 +9,8 @@
 
 ## Profiling support for Nim. This is an embedded profiler that requires
 ## `--profiler:on`. You only need to import this module to get a profiling
-## report at program exit.
+## report at program exit. See `Embedded Stack Trace Profiler <estp.html>`_
+## for usage.
 
 when not defined(profiler) and not defined(memProfiler):
   {.error: "Profiling support is turned off! Enable profiling by passing `--profiler:on --stackTrace:on` to the compiler (see the Nim Compiler User Guide for more options).".}