Re: Some ideas with Emacs

[Michael Albinus]

Eli Zaretskii <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.

Shall we say something like this in "(elisp) Documentation Tips"?

Best regards, Michael.