all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: asjo@koldfront.dk (Adam Sjøgren)
To: Lars Magne Ingebrigtsen <larsi@gnus.org>, Glenn Morris <rgm@gnu.org>
Cc: 9082@debbugs.gnu.org
Subject: bug#9082: Add hints to documentation of car and cdr for (e)lisp newcomers
Date: Thu, 14 Jul 2011 22:28:06 +0200	[thread overview]
Message-ID: <87wrfkboa1.fsf@topper.koldfront.dk> (raw)
In-Reply-To: <m3y600fwuj.fsf@quimbies.gnus.org> (Lars Magne Ingebrigtsen's message of "Thu, 14 Jul 2011 22:09:24 +0200")

I am sorry, but this is depressing.

Only a newbie would look up the documentation of car and cdr.

This newbie finds this documentation:

  "(car LIST) Return the car of LIST."
  "(cdr LIST) Return the cdr of LIST."

to be unhelpful to the brink of being a slap in the face.

"Nyah, nyah, you don't remember what part of a cons cell is named what -
 and we wo-on't tell you!"

Could you please consider trying to find a way to hint to the casual
lisp user which function does which?

I am perfectly fine with my suggestion being dismissed as meaningless
and wrong, and I agree that this is stuff you learn on your first day of
learning lisp.

But please try to put yourself into the mind of someone who remembers
the concept of those two functions, but can't remember which is which -
a casual user of lisp, looking up the functions in the builtin docs.

Sure, you can quickly try them, or you can figure out why the
(elisp)Cons cells link doesn't work in your emacs-snapshot instance and
read up on it there, or you can find the answer on wikipedia - but just
a little hint in the documentation of the functions we are talking about
would have quenched the frustration instantly.

The target demographic for these texts surely would be someone for whom
"car returns the car, cdr returns the cdr" isn't helping?

I hate to be such a bikeshedder, but I think that you two are way too
good at lisp to have reached the right solution here.

Anyway, thanks for your time.

  Best regards,

    Adam

-- 
 "Good car to drive after a war"                              Adam Sjøgren
                                                         asjo@koldfront.dk





  reply	other threads:[~2011-07-14 20:28 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-07-14 15:03 bug#9082: Add hints to documentation of car and cdr for (e)lisp newcomers Adam Sjøgren
2011-07-14 18:31 ` 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 [this message]
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=87wrfkboa1.fsf@topper.koldfront.dk \
    --to=asjo@koldfront.dk \
    --cc=9082@debbugs.gnu.org \
    --cc=larsi@gnus.org \
    --cc=rgm@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.