[Top][All Lists]

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

Re: [frogs] [PATCH] : Supply missing documentation strings in music-f

From: Ian Hulin
Subject: Re: [frogs] [PATCH] : Supply missing documentation strings in
Date: Mon, 26 Oct 2009 18:47:01 +0000
User-agent: Thunderbird (X11/20090817)

Neil Puttock wrote:
2009/10/25 Ian Hulin <address@hidden>:
Thanks for the feedback, Neil.  Is this OK to push now?

Sure is.

Woo-hoo, green light! Could someone with the relevant privileges push this to the main git repository, please?


>From 48d7cf640be9b78b398bc61d00aedbaa795cf540 Mon Sep 17 00:00:00 2001
From: Ian Hulin <address@hidden>
Date: Sun, 25 Oct 2009 22:42:37 +0000
Subject: [PATCH] [PATCH] Add missing documentation strings in 

 ly/ |   22 ++++++++++++++++------
 ly/        |   10 +++++++++-
 2 files changed, 25 insertions(+), 7 deletions(-)

diff --git a/ly/ b/ly/
index 718615a..4283157 100644
--- a/ly/
+++ b/ly/
@@ -449,7 +449,7 @@ or @code{\"GrobName\"}")
 %% because music identifiers are not allowed at top-level.
 pageBreak =
 #(define-music-function (location parser) ()
-   (_i "Force a page break. May be used at toplevel (ie between scores or
+   (_i "Force a page break. May be used at toplevel (i.e. between scores or
 markups), or inside a score.")
    (make-music 'EventChord
               'page-marker #t
@@ -584,13 +584,16 @@ parenthesize =
 partcombine =
 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
-               (make-part-combine-music parser
-                                        (list part1 part2)))
+   (_i "Take the music in @var{part1} and @var{part2} and typeset so that they 
share a staff.")
+   (make-part-combine-music parser
+                           (list part1 part2)))
 pitchedTrill =
    (parser location main-note secondary-note)
    (ly:music? ly:music?)
+   (_i "Print a trill with @var{main-note} as the main note of the trill and
+print @var{secondary-note} as a stemless note head in parentheses.")
        ((get-notes (lambda (ev-chord)
@@ -622,8 +625,12 @@ pitchedTrill =
 quoteDuring =
-  (parser location what main-music)
-  (string? ly:music?)
+   (parser location what main-music)
+   (string? ly:music?)
+   (_i "Indicate a section of music to be quoted.  @var{what} indicates the 
+of the quoted voice, as specified in an @code{\\addQuote} command.
address@hidden is used to indicate the length of music to be quoted;
+usually contains spacers or multi-measure rests.")
   (make-music 'QuoteMusic
              'element main-music
              'quoted-music-name what
@@ -803,7 +810,10 @@ tweak =
 unfoldRepeats =
 #(define-music-function (parser location music) (ly:music?)
-                 (unfold-repeats music))
+   (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or
address@hidden percent} commands in @var{music} to be interpreted
+as @code{\\repeat unfold}.")
+   (unfold-repeats music))
diff --git a/ly/ b/ly/
index 4983506..a73848e 100644
--- a/ly/
+++ b/ly/
@@ -278,7 +278,9 @@ phrasingSlurNeutral = \revert PhrasingSlur #'direction
 % dash-patterns (make-simple-dash-definition defined at top of file)
 phrasingSlurDashPattern =
 #(define-music-function (parser location dash-fraction dash-period)
-  (number? number?)
+   (number? number?)
+   (_i "Set up a custom style of dash pattern for @var{dash-fraction} ratio of
+line to space repeated at @var{dash-period} interval.")
      \override PhrasingSlur #'dash-definition =
        $(make-simple-dash-definition dash-fraction dash-period)
@@ -301,10 +303,16 @@ phrasingSlurSolid =
 pointAndClickOn  =
 #(define-music-function (parser location) ()
+   (_i "Enable generation of code in final-format (e.g. pdf) files to 
reference the
+originating lilypond source statement;
+this is helpful when developing a score but generates bigger final-format 
    (ly:set-option 'point-and-click #t)
    (make-music 'SequentialMusic 'void #t))
 pointAndClickOff =
 #(define-music-function (parser location) ()
+   (_i "Suppress generating extra code in final-format (e.g. pdf) files to 
+back to the lilypond source statement.")
    (ly:set-option 'point-and-click #f)
    (make-music 'SequentialMusic 'void #t))

reply via email to

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