stgit.el: Clarify documentation of stgit-capture-output

Signed-off-by: Gustav Hållberg <gustav@virtutech.com>
Signed-off-by: Karl Hasselström <kha@treskal.com>

diff --git a/contrib/stgit.el b/contrib/stgit.el
index de466db262fff891c7ff0b5072077ae36e4b06f8..c8d93684ca2d48ec0300bdda96ca9124c8a14343 100644 (file)
--- a/contrib/stgit.el
+++ b/contrib/stgit.el
@@ -65,7 +65,9 @@ (defun create-stgit-buffer (dir)
     buf))
 
 (defmacro stgit-capture-output (name &rest body)
     buf))
 
 (defmacro stgit-capture-output (name &rest body)

-  "Capture StGit output and show it in a window at the end."
+  "Capture StGit output and, if there was any output, show it in a window
+at the end.
+Returns nil if there was no output."

   `(let ((output-buf (get-buffer-create ,(or name "*StGit output*")))
          (stgit-dir default-directory)
          (inhibit-read-only t))
   `(let ((output-buf (get-buffer-create ,(or name "*StGit output*")))
          (stgit-dir default-directory)
          (inhibit-read-only t))