changeset 102784:a4b64232b4e0

(help-buffer): Add docstring.
author Chong Yidong <cyd@stupidchicken.com>
date Mon, 30 Mar 2009 01:06:27 +0000
parents 537208bc8c70
children a16c6f2e8622
files lisp/help-mode.el
diffstat 1 files changed, 4 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/help-mode.el	Mon Mar 30 01:06:14 2009 +0000
+++ b/lisp/help-mode.el	Mon Mar 30 01:06:27 2009 +0000
@@ -358,6 +358,10 @@
 
 ;;;###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)