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

[Jean-Christophe Helary]

> On Jul 16, 2021, at 9:22, Stefan Monnier <monnier@iro.umontreal.ca> wrote:
> 
>> The danger of going overboard is exactly what bothers me.  Which is
>> why I think examples in doc strings should be used in exceptional
>> cases, where they are absolutely necessary.  Not as a "why not?"
>> addition.
> 
> I don't think docstring should come with examples.  Examples should be
> provided separately for use by shortdoc.el and friends.

Do you have a list of "friends"? 

What is the way to add examples to the shordoc display ?

> Then `C-h f` can also show those examples, but it can place them
> elsewhere (e.g. hidden by default with a button to show them or
> something like that).

So, that mechanism does not exist yet, correct ?

-- 
Jean-Christophe Helary @brandelune
https://mac4translators.blogspot.com
https://sr.ht/~brandelune/omegat-as-a-book/