Re: Some ideas with Emacs

[Eli Zaretskii]

> From: Michael Albinus <address@hidden>
> Cc: Stefan Kangas <address@hidden>,  Eli Zaretskii <address@hidden>,
>   Anonymous <address@hidden>,  Emacs developers <address@hidden>
> Date: Fri, 29 Nov 2019 19:58:21 +0100
> 
> Stefan Monnier <address@hidden> writes:
> 
> > AFACT, currently we have some examples in the Elisp manual and very
> > few examples in docstrings.
> > It might be a good idea to encourage the addition of examples either in
> > docstrings or in the Elisp manual (or both).
> 
> Personally, I don't like docstring to be too verbose. Usually, when a
> function is documented with both docstrings and a manual, I prefer to
> put the examples in the manual.

I agree: the examples should be mostly in the manual.  Doc strings
should only have examples if it is otherwise very hard to explain
something.