From 48b0e214c7a0f7f3271e1af1321e09915a5fa939 Mon Sep 17 00:00:00 2001 From: Neil Puttock Date: Sun, 25 Oct 2009 14:49:15 +0000 Subject: [PATCH 2/2] Review docstring patch. --- ly/music-functions-init.ly | 26 +++++++++++++------------- ly/property-init.ly | 17 +++++++++-------- 2 files changed, 22 insertions(+), 21 deletions(-) diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly index a8a2ece..4283157 100644 --- a/ly/music-functions-init.ly +++ b/ly/music-functions-init.ly @@ -323,7 +323,7 @@ killCues = (music-map (lambda (mus) (if (and (string? (ly:music-property mus 'quoted-music-name)) - (string=? (ly:music-property mus 'quoted-context-id "") "cue")) + (string=? (ly:music-property mus 'quoted-context-id "") "cue")) (ly:music-property mus 'element) mus)) music)) @@ -450,7 +450,7 @@ or @code{\"GrobName\"}") pageBreak = #(define-music-function (location parser) () (_i "Force a page break. May be used at toplevel (i.e. between scores or - markups), or inside a score.") +markups), or inside a score.") (make-music 'EventChord 'page-marker #t 'line-break-permission 'force @@ -584,16 +584,16 @@ parenthesize = partcombine = #(define-music-function (parser location part1 part2) (ly:music? ly:music?) -(_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))) + (_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 = #(define-music-function -(_i "Print a trill with @var{main-note} as the main note of the trill and -print @var{secondary-note} as stemless note head in parentheses") (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.") (let* ((get-notes (lambda (ev-chord) (filter @@ -625,12 +625,12 @@ print @var{secondary-note} as stemless note head in parentheses") quoteDuring = #(define-music-function -(_i "Indicate a section of music to be quoted. @var{what} indicates the name -of the quoted voice, as specified in a @code{\\addQuote} command. + (parser location what main-music) + (string? ly:music?) + (_i "Indicate a section of music to be quoted. @var{what} indicates the name +of the quoted voice, as specified in an @code{\\addQuote} command. @var{main-music} is used to indicate the length of music to be quoted; usually contains spacers or multi-measure rests.") - (parser location what main-music) - (string? ly:music?) (make-music 'QuoteMusic 'element main-music 'quoted-music-name what @@ -811,8 +811,8 @@ tweak = unfoldRepeats = #(define-music-function (parser location music) (ly:music?) (_i "Force any @code{\\repeat volta}, @code{\\repeat tremolo} or - @code{\\repeat percent} commands in @var{music} to be interpreted - as @code{\\repeat unfold}.") address@hidden percent} commands in @var{music} to be interpreted +as @code{\\repeat unfold}.") (unfold-repeats music)) diff --git a/ly/property-init.ly b/ly/property-init.ly index 911c3ce..a73848e 100644 --- a/ly/property-init.ly +++ b/ly/property-init.ly @@ -278,9 +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?) -(_i "Set up a custom style of dash pattern for @var{dash-fraction} ratio of - line to space repeated at @var{dash-period} interval.") + (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) @@ -303,15 +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 files.") + (_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 files.") (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 point - back to the lilypond source statement.") + (_i "Suppress generating extra code in final-format (e.g. pdf) files to point +back to the lilypond source statement.") (ly:set-option 'point-and-click #f) (make-music 'SequentialMusic 'void #t)) -- 1.6.3.3