PATCH: Fix remaining define-music-function calls with no document string parameters

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

PATCH: Fix remaining define-music-function calls with no document string parameters

Ian Hulin


From fd650c51d754e5450fdf1760c7aec02a621b914f Mon Sep 17 00:00:00 2001
From: Ian Hulin <[hidden email]>
Date: Sun, 13 Sep 2009 12:14:07 +0100
Subject: [PATCH] Fix remaining define-music-function calls with no docstring parameters:
 \unfoldRepeats
 \pointAndClickOff
 \pointAndClickOn
 \slurDashPattern

Signed-off-by: Ian Hulin <ian@nanny-ogg.(none)>
---
 ly/music-functions-init.ly |    3 ++-
 ly/property-init.ly        |    7 +++++++
 2 files changed, 9 insertions(+), 1 deletions(-)

diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly
index 9085ed8..6a42f5c 100644
--- a/ly/music-functions-init.ly
+++ b/ly/music-functions-init.ly
@@ -810,10 +810,11 @@ tweak =
 
 unfoldRepeats =
 #(define-music-function (parser location music) (ly:music?)
+(_i "Force any @code{\\repeat volta} commands in @var{music} to be interpreted
+as @code{\\repeat unfold}.")
   (unfold-repeats music))
 
 
-
 withMusicProperty =
 #(define-music-function (parser location sym val music) (symbol? scheme? ly:music?)
    (_i "Set @var{sym} to @var{val} in @var{music}.")
diff --git a/ly/property-init.ly b/ly/property-init.ly
index 2880bff..24f0566 100644
--- a/ly/property-init.ly
+++ b/ly/property-init.ly
@@ -279,6 +279,8 @@ phrasingSlurNeutral = \revert PhrasingSlur #'direction
 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.")
   #{
      \override PhrasingSlur #'dash-definition =
        $(make-simple-dash-definition dash-fraction dash-period)
@@ -301,10 +303,15 @@ phrasingSlurSolid =
 
 pointAndClickOn  =
 #(define-music-function (parser location) ()
+(-i "Suppress generating extra code in final-format files to point back to the
+lilypond source statement.")
    (ly:set-option 'point-and-click #t)
    (make-music 'SequentialMusic 'void #t))
 pointAndClickOff =
 #(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.")
    (ly:set-option 'point-and-click #f)
    (make-music 'SequentialMusic 'void #t))
 
--
1.6.0.4

Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: PATCH: Fix remaining define-music-function calls with no document string parameters

Neil Puttock
+(_i "Force any @code{\\repeat volta} commands in @var{music} to be interpreted

This is a bit too specific, since \unfoldRepeats also applies to
\repeat tremolo and \repeat percent.

+(-i "Suppress generating extra code in final-format files to point back to the

typo: (_i

The docstrings for pointAndClickOn/Off are the wrong way round.

Please remove the trailing spaces.

Regards,
Neil

---

----
Join the Frogs!

Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: PATCH: Fix remaining define-music-function calls with no document string parameters

Ian Hulin
Hi Neil,

Neil Puttock wrote:
> +(_i "Force any @code{\\repeat volta} commands in @var{music} to be interpreted
>
> This is a bit too specific, since \unfoldRepeats also applies to
> \repeat tremolo and \repeat percent.
>  
Expanded to mention all three \repeat flavours.
> +(-i "Suppress generating extra code in final-format files to point back to the
>
> typo: (_i
>  
Sorted.
> The docstrings for pointAndClickOn/Off are the wrong way round.
>
> Please remove the trailing spaces.
>  
Done.

I've attached both patches; applying both  will do the whole job.

Cheers,

Ian



From 9d5c2043868e6709ff760263d0d35f05f538ba91 Mon Sep 17 00:00:00 2001
From: Ian Hulin <[hidden email]>
Date: Sun, 13 Sep 2009 00:01:26 +0100
Subject: [PATCH] Add docstrings without typos to \partcombine, \pitchedTrill and
 \quoteDuring music function definitions.

Signed-off-by: Ian Hulin <ian@nanny-ogg.(none)>
---
 ly/music-functions-init.ly |   10 +++++++++-
 1 files changed, 9 insertions(+), 1 deletions(-)

diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly
index a57a17b..9085ed8 100644
--- a/ly/music-functions-init.ly
+++ b/ly/music-functions-init.ly
@@ -583,13 +583,17 @@ parenthesize =
 
 partcombine =
 #(define-music-function (parser location part1 part2) (ly:music? ly:music?)
- (make-part-combine-music parser
+(_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
    (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 stemless note head in parentheses.")
    (let*
        ((get-notes (lambda (ev-chord)
      (filter
@@ -623,6 +627,10 @@ quoteDuring =
 #(define-music-function
   (parser location what main-music)
   (string? ly:music?)
+  (_i "Indicate a section of the music to be quoted.  @car{what} indicates the name
+of the quoted voice, as specified in a @code{\\addquote} command.
+@var{main-music} is used to indicate the length of the music to be quoted; it
+usually contains spacers or multi-measure rests.")
   (make-music 'QuoteMusic
       'element main-music
       'quoted-music-name what
--
1.6.0.4


From e2a659fa14f10ac5f5921d07592095a1e3a2c32f Mon Sep 17 00:00:00 2001
From: ian <[hidden email]>
Date: Wed, 16 Sep 2009 21:59:24 +0100
Subject: [PATCH] Fix remaining define-music-function calls with no docstring parameters:
 \unfoldRepeats
 \pointAndClickOff
 \pointAndClickOn
 \slurDashPattern

Signed-off-by: Ian Hulin <ian@nanny-ogg.(none)>
---
 ly/music-functions-init.ly |   14 ++++++++------
 ly/property-init.ly        |    7 +++++++
 2 files changed, 15 insertions(+), 6 deletions(-)

diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly
index 9085ed8..7204bbd 100644
--- a/ly/music-functions-init.ly
+++ b/ly/music-functions-init.ly
@@ -1,4 +1,4 @@
-% -*-Scheme-*-
+over% -*-Scheme-*-
 
 \version "2.12.0"
 
@@ -627,10 +627,10 @@ quoteDuring =
 #(define-music-function
   (parser location what main-music)
   (string? ly:music?)
-  (_i "Indicate a section of the music to be quoted.  @car{what} indicates the name
-of the quoted voice, as specified in a @code{\\addquote} command.
-@var{main-music} is used to indicate the length of the music to be quoted; it
-usually contains spacers or multi-measure rests.")
+  (_i "Indicate a section of the music to be quoted.  @var{what} indicates the name
+ of the quoted voice, as specified in a @code{\\addQuote} command.
+ @var{main-music} is used to indicate the length of the music to be quoted; it
+ usually contains spacers or multi-measure rests.")
   (make-music 'QuoteMusic
       'element main-music
       'quoted-music-name what
@@ -810,10 +810,12 @@ 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}.")
   (unfold-repeats music))
 
 
-
 withMusicProperty =
 #(define-music-function (parser location sym val music) (symbol? scheme? ly:music?)
    (_i "Set @var{sym} to @var{val} in @var{music}.")
diff --git a/ly/property-init.ly b/ly/property-init.ly
index 2880bff..a5a8d88 100644
--- a/ly/property-init.ly
+++ b/ly/property-init.ly
@@ -279,6 +279,8 @@ phrasingSlurNeutral = \revert PhrasingSlur #'direction
 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.")
   #{
      \override PhrasingSlur #'dash-definition =
        $(make-simple-dash-definition dash-fraction dash-period)
@@ -301,10 +303,15 @@ 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.")
    (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.")
    (ly:set-option 'point-and-click #f)
    (make-music 'SequentialMusic 'void #t))
 
--
1.6.0.4

Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: PATCH: Fix remaining define-music-function calls with no document string parameters

Neil Puttock
2009/9/16 Ian Hulin <[hidden email]>:

> I've attached both patches; applying both  will do the whole job.

Not quite... the first patch looks like an older revision.

The second patch seems OK though. :)

Regards,
Neil

---

----
Join the Frogs!

Loading...