Re: Doc: NR added @knownissue for beam properties (issue 5504100)

[pkx166h]

Reviewers: carl.d.sorensen_gmail.com, Keith,

Message:
On 2012/01/01 03:08:19, Carl wrote:

http://codereview.appspot.com/5504100/diff/1/Documentation/notation/rhythms.itely
> File Documentation/notation/rhythms.itely (right):


http://codereview.appspot.com/5504100/diff/1/Documentation/notation/rhythms.itely#newcode1954
> Documentation/notation/rhythms.itely:1954: The properties of a beam
are
> determined at the @emph{start} of its
> On 2012/01/01 02:59:06, Keith wrote:
> > I had no idea what this was about until going back to the tracker
issue.  The
> > surprising bit is with automatic beams, because you don't see where
they
> start,
> > so we need an example.  You might just say :
> > "If you change properties of beam when a beam has already started,
that beam
> > will not be affected.  For example, with the input {\hideNotes c8 f8
> > \unHideNotes c8 f8} the \hideNotes makes transparent the single
automatic beam
> > across all four notes.  If you want the beam to be visible for the
last two
> > notes you need to specify it explicitly. {\hideNotes c8 f8
\unHideNotes c8[
> f8]}

> This is why I recommend a snippet, rather than just the text.  If we
need to
> show a LilyPond example, we should show it with the output, rather
than just
> describing it in the text.

OK, but I think the example of \hideNotes, (that of the tracker) is too
complicated (or unnecessarily so).

Can we show this using a single voice with non-chorded notes and by
using something more 'obvious' than \hideNotes?



Description:
Doc: NR added @knownissue for beam properties

Used Carl S's wording from comment #3 of Tracker 1566

Also collated to separate @warnings together as they looked odd in the
doc
as two separate 'note' boxes one after the other.

Please review this at http://codereview.appspot.com/5504100/

Affected files:
  M Documentation/notation/rhythms.itely


Index: Documentation/notation/rhythms.itely
diff --git a/Documentation/notation/rhythms.itely  
b/Documentation/notation/rhythms.itely
index  
5719c73ea7e0eca3c1a02cefc77aeff049756ce3..9fb0c1961efefec32f68d5a70a4b6c1cd07e4337  
100644
--- a/Documentation/notation/rhythms.itely
+++ b/Documentation/notation/rhythms.itely
@@ -1899,10 +1899,9 @@ c16 c8

 @warning{If beams are used to indicate melismata in songs, then
 automatic beaming should be switched off with @code{\autoBeamOff}
-and the beams indicated manually.}
-
address@hidden @address@hidden with @address@hidden can
-produce unintended results.  See the snippet below for more information.}
+and the beams indicated manually.  Using @address@hidden with
address@hidden@bs{}autoBeamOff} can produce unintended results.  See the
+snippets for more information.}

 Beaming patterns that differ from the automatic defaults can be
 created; see @ref{Setting automatic beam behavior}.
@@ -1951,6 +1950,13 @@ Internals Reference:
 @rinternals{beam-interface},
 @rinternals{unbreakable-spanner-interface}.

address@hidden
+The properties of a beam are determined at the @emph{start} of its
+construction and any additional beam-property changes that occur before
+the beam has been completed will not take effect until the @emph{next},
+new beam starts.
+
+
 @node Setting automatic beam behavior
 @unnumberedsubsubsec Setting automatic beam behavior