Re: Add documentation for the music function \alterBroken to the NR. (issue 15060044)

[david . nalesnik]

On 2013/10/19 09:50:43, Trevor Daniels wrote:
> LGTM with a couple of nitpicks and a query
> (although I haven't tried a make doc to
> check the appearance of the examples).

> At first I was a little concerned about the
> explanations in what is supposed to be a
> _reference_ manual, but in this case I think
> they are justified.  They are well-written,
> not overly long, and the command is quite complex.

> Trevor


https://codereview.appspot.com/15060044/diff/1/Documentation/notation/changing-defaults.itely
Trevor,

When I uploaded the my changes, your inline comments aren't available
unfortunately.  (The good news is the side-by-side now is--at least for
me.)

I'll respond to your comments here.

> File Documentation/notation/changing-defaults.itely (right):


https://codereview.appspot.com/15060044/diff/1/Documentation/notation/changing-defaults.itely#newcode4318
> Documentation/notation/changing-defaults.itely:4318:
> "to" -> "on"

Done.  Oddly enough, I had it this way the first time around.



https://codereview.appspot.com/15060044/diff/1/Documentation/notation/changing-defaults.itely#newcode4369
> Documentation/notation/changing-defaults.itely:4369:
> replace full stop by a comma

Done.  You have better eyes than me!  (But I was distracted by the
perennial question: Oxford comma or no?)



https://codereview.appspot.com/15060044/diff/1/Documentation/notation/changing-defaults.itely#newcode4370
> Documentation/notation/changing-defaults.itely:4370:
> drop "to name several"

Done.


https://codereview.appspot.com/15060044/diff/1/Documentation/notation/changing-defaults.itely#newcode4396
> Documentation/notation/changing-defaults.itely:4396:
> Should there be a warning about not using \break
> to enforce line breaks?

The command will work if the break isn't forced.  The \breaks elsewhere
are only a consequence of the minimal examples.  If you think there
might be confusion, I could possibly add a comment to one of the \break
lines.  "\break added to force a line break on a short line.
\alterBroken does not require forced breaks."


https://codereview.appspot.com/15060044/