emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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


From: Stefan Monnier
Subject: Re: Add hints to documentation of car and cdr for (e)lisp newcomers - take 2
Date: Thu, 15 Jul 2021 11:21:42 -0400
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux)

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.




reply via email to

[Prev in Thread] Current Thread [Next in Thread]