From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>, Pankaj Jangid <pankaj@codeisgreat.org>
Cc: emacs-devel@gnu.org
Subject: RE: Reference to ‘alist’ in Emacs Lisp Manual without previous explanation
Date: Thu, 22 Oct 2020 08:31:25 -0700 (PDT) [thread overview]
Message-ID: <4bbbe967-9c1c-4cf6-9bb1-07420d8b4fb5@default> (raw)
In-Reply-To: <833626mmw7.fsf@gnu.org>
> > I am reading the Emacs Lisp Manual from beginning and
> > sequencially. Found reference to ‘alist’ in section 2.4.12 Hash Table
> > Type without any previous explanation.
> >
> > Either a brief summary should be provided before this, probably near
> > 2.4.6 Cons Cell and List Types or a cross-reference should be added.
>
> If you are reading the manual in order, you should have read 2.4.6.3
> "Association List Type", where "alist" is explained, before you got to
> 2.4.12. How come you didn't see that?
Yes, "if". Aside from whether Pankaj should have
seen that:
People don't necessarily (or even often) read manuals
"in order".
Even when they do, it can help to put important terms
in a glossary, and add links from the glossary to
topics that also define, or otherwise expand on the
terms.
The Emacs manual has a glossary (`g glossary'), but
the Elisp manual doesn't. It could have one too.
Links from occurrences to glossary entries (or if
no glossary, to a defining topic) can help. E.g.,
put a glossary link on the first occurrence of a
term in a given topic, especially if understanding
the term is important to understanding that topic.
next prev parent reply other threads:[~2020-10-22 15:31 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-22 5:40 Reference to ‘alist’ in Emacs Lisp Manual without previous explanation Pankaj Jangid
2020-10-22 6:42 ` Subject: " Alfred M. Szmidt
2020-10-22 13:05 ` Eli Zaretskii
2020-10-22 15:31 ` Drew Adams [this message]
2020-10-23 7:22 ` Pankaj Jangid
2020-10-23 10:55 ` Eli Zaretskii
2020-10-23 15:10 ` Pankaj Jangid
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=4bbbe967-9c1c-4cf6-9bb1-07420d8b4fb5@default \
--to=drew.adams@oracle.com \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=pankaj@codeisgreat.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.