summaryrefslogtreecommitdiff
path: root/lisp/help-mode.el
diff options
context:
space:
mode:
authorChong Yidong <cyd@stupidchicken.com>2009-03-30 01:06:27 +0000
committerChong Yidong <cyd@stupidchicken.com>2009-03-30 01:06:27 +0000
commitf1389359d0f7e7170d6b5fca7d3206136d836ac2 (patch)
tree7b674031374818a61566f6465fc580a54f098e3d /lisp/help-mode.el
parentc2ba9ee0b090b396021e3f3a6184f2b29d1c9d47 (diff)
downloademacs-f1389359d0f7e7170d6b5fca7d3206136d836ac2.tar.gz
(help-buffer): Add docstring.
Diffstat (limited to 'lisp/help-mode.el')
-rw-r--r--lisp/help-mode.el4
1 files changed, 4 insertions, 0 deletions
diff --git a/lisp/help-mode.el b/lisp/help-mode.el
index d1e89705077..bbd1dfec131 100644
--- a/lisp/help-mode.el
+++ b/lisp/help-mode.el
@@ -358,6 +358,10 @@ restore it properly when going back."
;;;###autoload
(defun help-buffer ()
+ "Return a buffer for inserting help.
+If `help-xref-following' is non-nil, this is the current buffer.
+Otherwise, it is the buffer named *Help*. If no such buffer
+currently exists, it is created."
(buffer-name ;for with-output-to-temp-buffer
(if help-xref-following
(current-buffer)