From: Eli Zaretskii <eliz@gnu.org>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: larsi@gnus.org, stefan@marxist.se, asjo@koldfront.dk,
emacs-devel@gnu.org
Subject: Re: Add hints to documentation of car and cdr for (e)lisp newcomers - take 2
Date: Thu, 15 Jul 2021 18:53:57 +0300 [thread overview]
Message-ID: <83tukv60a2.fsf@gnu.org> (raw)
In-Reply-To: <jwvk0lrpprh.fsf-monnier+emacs@gnu.org> (message from Stefan Monnier on Thu, 15 Jul 2021 11:21:42 -0400)
> From: Stefan Monnier <monnier@iro.umontreal.ca>
> Cc: Stefan Kangas <stefan@marxist.se>, larsi@gnus.org, asjo@koldfront.dk,
> emacs-devel@gnu.org
> Date: Thu, 15 Jul 2021 11:21:42 -0400
>
> > IMO, examples are for the manual, not for the doc strings. If some
> > parts of our manuals could benefit from more examples, patches for
> > that would be welcome.
>
> I think displaying the examples we have in shortdoc.el in the
> *Help* buffer would make a lot of sense.
Trivial examples bloat the session memory without any significant
effect on documentation quality. People who must have examples should
really read the manual, IMO.
next prev parent reply other threads:[~2021-07-15 15:53 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-14 15:05 Add hints to documentation of car and cdr for (e)lisp newcomers - take 2 Adam Sjøgren
2021-07-14 15:36 ` Andreas Schwab
2021-07-14 15:48 ` tomas
2021-07-14 15:50 ` Eli Zaretskii
2021-07-14 16:03 ` Lars Ingebrigtsen
2021-07-14 16:13 ` Eli Zaretskii
2021-07-15 4:34 ` Lars Ingebrigtsen
2021-07-14 23:49 ` Stefan Kangas
2021-07-15 4:38 ` Lars Ingebrigtsen
2021-07-15 11:39 ` Stefan Kangas
2021-07-15 14:14 ` Eli Zaretskii
2021-07-15 15:02 ` Tim Cross
2021-07-15 15:41 ` Stefan Monnier
2021-07-15 15:21 ` Stefan Monnier
2021-07-15 15:26 ` Yuan Fu
2021-07-15 15:52 ` Eduardo Ochs
2021-07-15 15:44 ` Lars Ingebrigtsen
2021-07-15 15:57 ` Eli Zaretskii
2021-07-16 0:22 ` Stefan Monnier
2021-07-16 2:08 ` Jean-Christophe Helary
2021-07-16 13:22 ` Stefan Monnier
2021-07-16 14:38 ` Basil L. Contovounesios
2021-07-16 7:00 ` Eli Zaretskii
2021-07-15 15:53 ` Eli Zaretskii [this message]
2021-07-15 16:17 ` Jean-Christophe Helary
2021-07-15 16:30 ` Lars Ingebrigtsen
2021-07-15 16:57 ` Eli Zaretskii
2021-07-15 17:01 ` Lars Ingebrigtsen
2021-07-15 17:07 ` Eli Zaretskii
2021-07-15 20:54 ` Stefan Kangas
2021-07-15 21:11 ` Lars Ingebrigtsen
2021-07-14 16:37 ` [External] : " 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=83tukv60a2.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=asjo@koldfront.dk \
--cc=emacs-devel@gnu.org \
--cc=larsi@gnus.org \
--cc=monnier@iro.umontreal.ca \
--cc=stefan@marxist.se \
/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.