/[emacs]/emacs/lispref/functions.texi
ViewVC logotype

Diff of /emacs/lispref/functions.texi

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.22 by rms, Mon Jun 30 10:40:27 2003 UTC revision 1.23 by rms, Tue Jul 22 15:22:50 2003 UTC
# Line 411  of one or two complete sentences that su Line 411  of one or two complete sentences that su
411  but since these spaces come before the starting double-quote, they are not part of  but since these spaces come before the starting double-quote, they are not part of
412  the string.  Some people make a practice of indenting any additional  the string.  Some people make a practice of indenting any additional
413  lines of the string so that the text lines up in the program source.  lines of the string so that the text lines up in the program source.
414  @emph{This is a mistake.}  The indentation of the following lines is  @emph{That is a mistake.}  The indentation of the following lines is
415  inside the string; what looks nice in the source code will look ugly  inside the string; what looks nice in the source code will look ugly
416  when displayed by the help commands.  when displayed by the help commands.
417    
# Line 423  practice, there is no confusion between Line 423  practice, there is no confusion between
423  documentation string; if the only body form is a string then it serves both  documentation string; if the only body form is a string then it serves both
424  as the return value and as the documentation.  as the return value and as the documentation.
425    
426      The last line of the documentation string can specify calling
427    conventions different from the actual function arguments.  Write
428    text like this:
429    
430    @example
431    (fn @var{arglist})
432    @end example
433    
434    @noindent
435    following a blank line, with no newline following it inside the
436    documentation string.  This feature is particularly useful for
437    macro definitions.
438    
439  @node Function Names  @node Function Names
440  @section Naming a Function  @section Naming a Function
441  @cindex function definition  @cindex function definition

Legend:
Removed from v.1.22  
changed lines
  Added in v.1.23

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26