]> code.delx.au - gnu-emacs/blobdiff - doc/lispref/help.texi
Merge from trunk.
[gnu-emacs] / doc / lispref / help.texi
index 026258f24723213427810680bb38c71363263cc1..0ce05d55a07bb5c667e394b8c2b99c9afd709d0e 100644 (file)
@@ -1,7 +1,7 @@
 @c -*-texinfo-*-
 @c This is part of the GNU Emacs Lisp Reference Manual.
-@c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001,
-@c   2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010  Free Software Foundation, Inc.
+@c Copyright (C) 1990-1995, 1998-1999, 2001-2011
+@c   Free Software Foundation, Inc.
 @c See the file elisp.texi for copying conditions.
 @setfilename ../../info/help
 @node Documentation, Files, Modes, Top
@@ -78,11 +78,12 @@ function or variable that it describes:
 @item
 @kindex function-documentation
 The documentation for a function is usually stored in the function
-definition itself (@pxref{Lambda Expressions}).  The function
-@code{documentation} knows how to extract it.  You can also put
-function documentation in the @code{function-documentation} property
-of the function name.  That is useful with definitions such as
-keyboard macros that can't hold a documentation string.
+definition itself (@pxref{Lambda Expressions} and @pxref{Function
+Documentation}).  The function @code{documentation} knows how to
+extract it.  You can also put function documentation in the
+@code{function-documentation} property of the function name.  That is
+useful with definitions such as keyboard macros that can't hold a
+documentation string.
 
 @item
 @kindex variable-documentation
@@ -106,12 +107,6 @@ documentation string.  The functions @code{documentation} and
 documentation string from the appropriate file; this is transparent to
 the user.
 
-@c Wordy to prevent overfull hbox.  --rjc 15mar92
-  The @file{emacs/lib-src} directory contains two utilities that you can
-use to print nice-looking hardcopy for the file
-@file{emacs/etc/DOC-@var{version}}.  These are @file{sorted-doc} and
-@file{digest-doc}.
-
 @node Accessing Documentation
 @section Access to Documentation Strings
 
@@ -144,9 +139,9 @@ unless @var{verbatim} is non-@code{nil}.
 @end defun
 
 @defun documentation function &optional verbatim
-This function returns the documentation string of @var{function}.
-@code{documentation} handles macros, named keyboard macros, and
-special forms, as well as ordinary functions.
+This function returns the documentation string of @var{function}.  It
+handles macros, named keyboard macros, and special forms, as well as
+ordinary functions.
 
 If @var{function} is a symbol, this function first looks for the
 @code{function-documentation} property of that symbol; if that has a
@@ -551,7 +546,7 @@ follows:
 
 @smallexample
 @group
-(define-key global-map (char-to-string help-char) 'help-command)
+(define-key global-map (string help-char) 'help-command)
 (fset 'help-command help-map)
 @end group
 @end smallexample
@@ -701,6 +696,3 @@ echo area at first, and display the longer @var{help-text} strings only
 if the user types the help character again.
 @end defopt
 
-@ignore
-   arch-tag: ba36b4c2-e60f-49e2-bc25-61158fdcd815
-@end ignore