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

[Lars Ingebrigtsen]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

>> 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 having some examples is fine in doc strings -- it can be
difficult to explain some concepts in words, but a simple example can be
a really efficient way to say what a function does.

But we should indeed not go overboard with examples in doc strings --
that's better left for the manual.

> I think displaying the examples we have in shortdoc.el in the
> *Help* buffer would make a lot of sense.

Yeah, I agree.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no