emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Documentation for car and cdr


From: Alfred M\. Szmidt
Subject: Re: Documentation for car and cdr
Date: Wed, 25 Jan 2006 23:01:33 +0100

   >> ,----[ M-x describe-function <RET> cdr <RET> ]
   >> | cdr is a built-in function in `C source code'.
   >> | (cdr list)
   >> | 
   >> | Return the cdr of list.  If arg is nil, return nil.
   >> | Error if arg is not nil and not a cons cell.  See also `cdr-safe'.
   >> `----

[...]

   This description of the function is near useless.

The same applies to many other functions, take bobp and a novice
programmer, and she will ask `what is a buffer?'.  Some level of
knowledge about the function must be assumed for docstrings.  What the
car/cdr of a list is, is already explained in the Introduction to
Emacs Lisp manual and that is where a novice programmer will have to
start to understand many things about emacs, like lists, frames,
windows, buffers, arrays, strings, vectors, special forms, etc.




reply via email to

[Prev in Thread] Current Thread [Next in Thread]