From: asjo@koldfront.dk (Adam Sjøgren)
To: 9082@debbugs.gnu.org
Subject: bug#9082: Add hints to documentation of car and cdr for (e)lisp newcomers
Date: Thu, 14 Jul 2011 17:03:30 +0200 [thread overview]
Message-ID: <8762n4ewfx.fsf@topper.koldfront.dk> (raw)
** Description
Adds hints to the documentation of car and cdr to help newbies remember
which is which.
Saying that (car|cdr) returns the (car|cdr) of a LIST is a little terse
for beginners (probably the only ones looking at the documentation of
such basic functions).
** ChangeLog
2011-07-14 Adam Sjøgren <asjo@koldfront.dk>
* data.c (car, cdr): add functionality hints to documentation.
** Patch
=== modified file 'src/data.c'
*** src/data.c 2011-07-10 08:20:10 +0000
--- src/data.c 2011-07-14 13:23:02 +0000
*************** DEFUN ("floatp", Ffloatp, Sfloatp, 1, 1,
*** 463,469 ****
/* Extract and set components of lists */
DEFUN ("car", Fcar, Scar, 1, 1, 0,
! doc: /* Return the car of LIST. If arg is nil, return nil.
Error if arg is not nil and not a cons cell. See also `car-safe'.
See Info node `(elisp)Cons Cells' for a discussion of related basic
--- 463,469 ----
/* Extract and set components of lists */
DEFUN ("car", Fcar, Scar, 1, 1, 0,
! doc: /* Return the car (first element) of LIST. If arg is nil, return nil.
Error if arg is not nil and not a cons cell. See also `car-safe'.
See Info node `(elisp)Cons Cells' for a discussion of related basic
*************** DEFUN ("car-safe", Fcar_safe, Scar_safe,
*** 481,487 ****
}
DEFUN ("cdr", Fcdr, Scdr, 1, 1, 0,
! doc: /* 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'.
See Info node `(elisp)Cons Cells' for a discussion of related basic
--- 481,487 ----
}
DEFUN ("cdr", Fcdr, Scdr, 1, 1, 0,
! doc: /* Return the cdr (rest) of LIST. If arg is nil, return nil.
Error if arg is not nil and not a cons cell. See also `cdr-safe'.
See Info node `(elisp)Cons Cells' for a discussion of related basic
next reply other threads:[~2011-07-14 15:03 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-07-14 15:03 Adam Sjøgren [this message]
2011-07-14 18:31 ` bug#9082: Add hints to documentation of car and cdr for (e)lisp newcomers Lars Magne Ingebrigtsen
2011-07-14 19:19 ` Adam Sjøgren
2011-07-14 19:47 ` Glenn Morris
2011-07-14 20:09 ` Lars Magne Ingebrigtsen
2011-07-14 20:28 ` Adam Sjøgren
2011-07-14 20:37 ` Lars Magne Ingebrigtsen
2011-07-14 21:20 ` bug#9082: Add hints to documentation of car and cdr for (e)lispnewcomers Drew Adams
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8762n4ewfx.fsf@topper.koldfront.dk \
--to=asjo@koldfront.dk \
--cc=9082@debbugs.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.