[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Some ideas with Emacs
From: |
Eli Zaretskii |
Subject: |
Re: Some ideas with Emacs |
Date: |
Fri, 29 Nov 2019 21:32:30 +0200 |
> 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.
- Re: Some ideas with Emacs, (continued)
- Re: Some ideas with Emacs, Stefan Kangas, 2019/11/29
- Re: Some ideas with Emacs, Eduardo Ochs, 2019/11/29
- Re: Some ideas with Emacs, Eli Zaretskii, 2019/11/29
- Re: Some ideas with Emacs, Anonymous, 2019/11/29
- Re: Some ideas with Emacs, Stefan Kangas, 2019/11/29
- Re: Some ideas with Emacs, Stefan Monnier, 2019/11/29
- Re: Some ideas with Emacs, Michael Albinus, 2019/11/29
- Adding examples in the doc (was: Some ideas with Emacs), Stefan Monnier, 2019/11/29
- Re: Adding examples in the doc (was: Some ideas with Emacs), Yuan Fu, 2019/11/29
- Re: Adding examples in the doc, Michael Albinus, 2019/11/29
- Re: Some ideas with Emacs,
Eli Zaretskii <=
- Re: Some ideas with Emacs, Michael Albinus, 2019/11/29
- Re: Some ideas with Emacs, Eli Zaretskii, 2019/11/29
- Re: Some ideas with Emacs, Michael Albinus, 2019/11/29
- Re: Some ideas with Emacs, Eli Zaretskii, 2019/11/29
- Re: Some ideas with Emacs, Clément Pit-Claudel, 2019/11/29
- Re: Some ideas with Emacs, João Távora, 2019/11/29
- Re: Some ideas with Emacs, Yuan Fu, 2019/11/29
- Re: Some ideas with Emacs, Stefan Kangas, 2019/11/29
- Re: Some ideas with Emacs, Eli Zaretskii, 2019/11/30
- Re: Some ideas with Emacs, Eli Zaretskii, 2019/11/30