Re: Add hints to documentation of car and cdr for (e)lisp newcomers - take 2

[Yuan Fu]

On Jul 15, 2021, at 11:21 AM, Stefan Monnier <monnier@iro.umontreal.ca> wrote:

Eli Zaretskii [2021-07-15 17:14:18] wrote:

From: Stefan Kangas <stefan@marxist.se>
Date: Thu, 15 Jul 2021 13:39:54 +0200
Cc: Eli Zaretskii <eliz@gnu.org>, Adam Sjøgren <asjo@koldfront.dk>,
Emacs developers <emacs-devel@gnu.org>
In general, I think we should include more examples in our
documentation.  shortdoc.el is a step forward here, and it would be
even better if you could see those examples when you pull up the
docstring of a function.

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.

Some one wrote quite a few examples here: https://github.com/xuchunyang/elisp-demos

Yuan