bug-lilypond
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Possible documentation error in 2.7.2


From: Carl Sorensen
Subject: Re: Possible documentation error in 2.7.2
Date: Sat, 29 Feb 2020 19:39:11 +0000
User-agent: Microsoft-MacOutlook/10.10.13.200210


´╗┐On 2/29/20, 1:46 AM, "Ben Eichler" <address@hidden> wrote:

    HI there,
    
    
    I read at "2.7.2 Displaying Chords" in the docs: "*Chord names can be
    displayed only at the start of lines and when the chord changes.*"
    
    This is a little bit misleading. By default, each chord in the content is
    printed by Lilypond. The documentation is trying to point out that this
    behaviour can be overridden, but this is not apparent to new readers of the
    documentation.
    
    Could this sentence in the documentation be clarified to something like
    this: *"By default, each chord in the content is printed. This behaviour
    can be overridden using the chordChanges setting, as shown below."*

The original sentence is in a selected snippet.  ALL of the selected snippets 
are used to show overrides, because we try to avoid overrides in the main body 
of the text.

The second sentence of your proposal goes against the documentation policy.  We 
don't talk through the code.  We consciously and deliberately make these 
descriptions as short as possible.

Something like "The ChordNames context can be set to display chord names only 
at the start of lines and when the chord changes." would be more consistent 
with our policy, although listing the context name is suspect.  How would you 
feel about that sentence?

Thanks,

Carl
    


reply via email to

[Prev in Thread] Current Thread [Next in Thread]