Re: Adding examples in the doc (was: Some ideas with Emacs)

[Yuan Fu]

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.

I tend to agree.  Of course part of it is that a verbose docstring is an
indication that the function is complex to use, but there's also simply
the impact on the visual distance between the function header and the code.

FYI there is a package that does similar things: https://github.com/xuchunyang/elisp-demos

Yuan