From 0c536f0cadb43503396181ad214ed80ee01dbe50 Mon Sep 17 00:00:00 2001
From: Fredrik Ekre <ekrefredrik@gmail.com>
Date: Wed, 17 Jul 2019 15:33:57 +0200
Subject: [PATCH] Add a note about what Documenter shows, fixes  #63.

---
 examples/example.jl | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/examples/example.jl b/examples/example.jl
index a7e865b..8add47a 100644
--- a/examples/example.jl
+++ b/examples/example.jl
@@ -58,6 +58,12 @@ x * y
 # `execute` keyword argument is set to true. Output to `stdout`/`stderr` is also
 # captured.
 
+#md # !!! note
+#md #     Note that Documenter currently only displays output to `stdout`/`stderr`
+#md #     if there is no other result to show. Since the vector `[1, 2, 3, 4]` is
+#md #     returned from `foo`, the printing of `"This string is printed to stdout."`
+#md #     is hidden.
+
 function foo()
     println("This string is printed to stdout.")
     return [1, 2, 3, 4]