[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [GLISS] - alternative viewpoint
From: |
James |
Subject: |
Re: [GLISS] - alternative viewpoint |
Date: |
Mon, 24 Sep 2012 11:53:41 +0100 |
Hello,
On 24 September 2012 09:22, Jan Nieuwenhuizen <address@hidden> wrote:
> David Kastrup writes:
>
>> I think it was during the documentation of the footnote stuff that we
>> came up with several examples (including use of s1*0/<>) that made clear
>> that we were better off refining the code rather than the documentation.
>>
>> And that's fine. Changing code because it would be too embarrassing to
>> document it is certainly a better option than leaving it undocumented.
>
> New functionality must come with minimal documentation, otherwise it
> does not exist. We cannot expect from documentation writers to work
> from reading the code.
>
I think we kind of had this conversation a few months (last year?) and
that the very least it should appear here:
http://lilypond.org/doc/v2.16/Documentation/changes/index.html
Most developers do try, or at least say there is no/should be
documentation for a new feature.
@devs-in-general
I've always offered to tidy up any submitted documentation (i.e. via
email or text file) and form a patch if that is too time consuming;
all I ask is to suggest an appropriate place/section that it should go
- this saves me a lot of time. The hardest thing to come up with are
'good' lilypond examples - indeed the footnote documentation in the NR
(initially) was spawned from Mikes own reg tests, that is better than
nothing.
James
- Re: [GLISS] - alternative viewpoint, (continued)
- Re: [GLISS] - alternative viewpoint, David Kastrup, 2012/09/21
- Re: [GLISS] - alternative viewpoint, Marc Hohl, 2012/09/22
- Re: [GLISS] - alternative viewpoint, Janek Warchoł, 2012/09/22
- Re: [GLISS] - alternative viewpoint, Graham Percival, 2012/09/23
- Re: [GLISS] - alternative viewpoint, Marc Hohl, 2012/09/23
- Re: [GLISS] - alternative viewpoint, Sue Daniels, 2012/09/24
- Re: [GLISS] - alternative viewpoint, David Kastrup, 2012/09/23
- Re: [GLISS] - alternative viewpoint, James, 2012/09/23
- Re: [GLISS] - alternative viewpoint, David Kastrup, 2012/09/23
- Re: [GLISS] - alternative viewpoint, Jan Nieuwenhuizen, 2012/09/24
- Re: [GLISS] - alternative viewpoint,
James <=
- Re: [GLISS] - alternative viewpoint, David Kastrup, 2012/09/24
- Re: [GLISS] - alternative viewpoint, Janek Warchoł, 2012/09/22
- Re: [GLISS] - alternative viewpoint, Janek Warchoł, 2012/09/17
- Re: [GLISS] - alternative viewpoint, Janek Warchoł, 2012/09/24
- Re: [GLISS] - alternative viewpoint, David Kastrup, 2012/09/15
- Re: [GLISS] - alternative viewpoint, Werner LEMBERG, 2012/09/15
- Re: [GLISS] - alternative viewpoint, Janek Warchoł, 2012/09/16
- Re: [GLISS] - alternative viewpoint, David Kastrup, 2012/09/16
- Re: [GLISS] - alternative viewpoint, Janek Warchoł, 2012/09/22
Re: [GLISS] - alternative viewpoint, Keith OHara, 2012/09/15