[Lilypond-auto] [LilyIssues-auto] [testlilyissues:issues] #5807 Doc: NR - Clarify that default chord settings can be overridden

[Auto mailings of changes to Lily Issues via Testlilyissues-auto]

On 29/02/2020 19:39, Carl Sorensen wrote:

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

---

[issues:#5807] Doc: NR - Clarify that default chord settings can be overridden

Status: New
Created: Sat Feb 29, 2020 10:17 AM UTC by pkx166h
Last Updated: Sat Feb 29, 2020 10:17 AM UTC
Owner: nobody

On 29/02/2020 08:46, Ben Eichler 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."

Kind regards,

-Ben

---

Sent from sourceforge.net because address@hidden is subscribed to https://sourceforge.net/p/testlilyissues/issues/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/testlilyissues/admin/issues/options. Or, if this is a mailing list, you can unsubscribe from the mailing list.

_______________________________________________
Testlilyissues-auto mailing list
address@hidden
https://lists.sourceforge.net/lists/listinfo/testlilyissues-auto