[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: docstrings and elisp reference
From: |
Stephen Leake |
Subject: |
Re: docstrings and elisp reference |
Date: |
Tue, 06 Jun 2017 15:25:21 -0500 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/25.1.91 (windows-nt) |
Eli Zaretskii <address@hidden> writes:
>> From: Jean-Christophe Helary <address@hidden>
>> Date: Tue, 6 Jun 2017 14:10:19 +0900
>>
>> Having a mechanism that generates automatic documentation (a la
>> javadoc) would be extremely valuable.
>
> It could be valuable, but IMO only if we exercise a lot of discipline
> in producing those comments. Because every project which uses this
> methodology that I looked at ends up providing _abysmally_ inadequate
> documentation.
+1
Doc strings are for short reference information for single functions/variables.
texinfo docs are for more indepth explanations of several related
functions/features.
They are complementary; they should not duplicate each other.
--
-- Stephe
- docstrings and elisp reference, Jean-Christophe Helary, 2017/06/05
- Re: docstrings and elisp reference, Tino Calancha, 2017/06/05
- Re: docstrings and elisp reference, Jean-Christophe Helary, 2017/06/06
- Re: docstrings and elisp reference, Eli Zaretskii, 2017/06/06
- Re: docstrings and elisp reference,
Stephen Leake <=
- RE: docstrings and elisp reference, Drew Adams, 2017/06/06
- Re: docstrings and elisp reference, Etienne Prud’homme, 2017/06/07
- Re: docstrings and elisp reference, Jean-Christophe Helary, 2017/06/07
- Re: docstrings and elisp reference, Chad Brown, 2017/06/08
- Re: docstrings and elisp reference, Jean-Christophe Helary, 2017/06/08
- Re: docstrings and elisp reference, Eli Zaretskii, 2017/06/08
- Re: docstrings and elisp reference, Jean-Christophe Helary, 2017/06/08
- Re: docstrings and elisp reference, Chad Brown, 2017/06/08
- Re: docstrings and elisp reference, Etienne Prud’homme, 2017/06/08
- Re: docstrings and elisp reference, Richard Stallman, 2017/06/09