[PATCH] : Supply missing documentation strings in music-function-init.ly

classic Classic list List threaded Threaded
9 messages Options
Reply | Threaded
Open this post in threaded view
|

[PATCH] : Supply missing documentation strings in music-function-init.ly

Ian Hulin
Please push if these changes look OK.

Cheers,

Ian

From c602f0c384450a7f7a3500858696ce7132c761e8 Mon Sep 17 00:00:00 2001
From: ian <[hidden email]>
Date: Tue, 20 Oct 2009 17:57:04 +0100
Subject: [PATCH] Add missing documentation strings to declarations in
 music-functions-init.ly.

---
 ly/init.ly                 |    4 ++--
 ly/music-functions-init.ly |    9 ++++++++-
 ly/property-init.ly        |    7 +++++++
 3 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/ly/init.ly b/ly/init.ly
index 9304810..6fe41c4 100644
--- a/ly/init.ly
+++ b/ly/init.ly
@@ -7,12 +7,12 @@
 \version "2.12.0"
 
 \include "declarations-init.ly"
-
+#(use-modules (ice-9 q))
 
 #(ly:set-option 'old-relative #f)
 #(define toplevel-scores (list))
 #(define toplevel-bookparts (list))
-#(define output-count 0)
+#(define output-count 0)            % Now only used in regression tests
 #(define $defaultheader #f)
 #(define $current-book #f)
 #(define $current-bookpart #f)
diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly
index 718615a..81bbca7 100644
--- a/ly/music-functions-init.ly
+++ b/ly/music-functions-init.ly
@@ -584,11 +584,14 @@ 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
+(_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 paretheses")
    (parser location main-note secondary-note)
    (ly:music? ly:music?)
    (let*
@@ -622,6 +625,10 @@ pitchedTrill =
 
 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.  
+@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
diff --git a/ly/property-init.ly b/ly/property-init.ly
index 4983506..4dd66f9 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
|

Re: [PATCH] : Supply missing documentation strings in music-function-init.ly

Neil Puttock
2009/10/20 Ian Hulin <[hidden email]>:
> Please push if these changes look OK.

Hmm, this looks suspiciously like one of the patches you posted last
month, but missing some of the changes I suggested.

+#(use-modules (ice-9 q))

I can't see any procedures from this module in init.ly.

+#(define output-count 0)            % Now only used in regression tests

This isn't user serviceable any more, so you might as well clear out
all remaining references to it (and the obsolete code).

+(_i "Take the music in @var{part1} and @var{part2} and typeset so
that they share a staff")

staff.")

+(_i "Print a trill with @var{main-note} as the main note of the trill and

trailing space, docstring goes after predicate list

+print @var{secondary-note} as stemless note head in paretheses")

parentheses.")

+(_i "Indicate a section of music to be quoted.  @var{what} indicates the name

trailing space, docstring goes after predicate list

+of the quoted voice, as specified in a @code{\addquote} command.

trailing spaces, @code{\\addQuote}

+(_i "Set up a custom style of dash pattern for @var{dash-fraction} ratio of

trailing space

+(_i "Set up a custom style of dash pattern for @var{dash-fraction} ratio of

trailing space

In all cases, the indentation needs fixing.

Regards,
Neil

---

----
Join the Frogs!

Reply | Threaded
Open this post in threaded view
|

Re: [PATCH] : Supply missing documentation strings in music-function-init.ly

Ian Hulin

Neil Puttock wrote:
2009/10/20 Ian Hulin [hidden email]:
  
Please push if these changes look OK.
    

Hmm, this looks suspiciously like one of the patches you posted last
month, but missing some of the changes I suggested.
  
Cor, blimey, guv'nor, you've got me banged to rights (serves me right for trying to tidy up my git repository).
+#(use-modules (ice-9 q))

I can't see any procedures from this module in init.ly.
  
Changed from another patch I was working on, reverted for this patch.
+#(define output-count 0)            % Now only used in regression tests

This isn't user serviceable any more, so you might as well clear out
all remaining references to it (and the obsolete code).
  
Removed.  The only remaining thing I could see in git which used it was a regression test where the whole lot of code was commented out (input/regression/backend-svg.ly).  Reinhold has already changed the regression test where it is actually used.
+(_i "Take the music in @var{part1} and @var{part2} and typeset so
that they share a staff")

staff.")

+(_i "Print a trill with @var{main-note} as the main note of the trill and

trailing space, docstring goes after predicate list

+print @var{secondary-note} as stemless note head in paretheses")

parentheses.")

+(_i "Indicate a section of music to be quoted.  @var{what} indicates the name

trailing space, docstring goes after predicate list

+of the quoted voice, as specified in a @code{\addquote} command.

trailing spaces, @code{\\addQuote}

+(_i "Set up a custom style of dash pattern for @var{dash-fraction} ratio of

trailing space

+(_i "Set up a custom style of dash pattern for @var{dash-fraction} ratio of

trailing space
  
All these are re-applied.
In all cases, the indentation needs fixing.
  
Have run the code through the Frescobaldi indent tool.

Now is it OK to push?

Cheers,
Ian


Reply | Threaded
Open this post in threaded view
|

Re: [PATCH] : Supply missing documentation strings in music-function-init.ly

Ian Hulin
And here's the patch actually attached (sorry for the noise).

Ian

Ian Hulin wrote:

>
> Neil Puttock wrote:
>> 2009/10/20 Ian Hulin <[hidden email]>:
>>  
>>> Please push if these changes look OK.
>>>    
>>
>> Hmm, this looks suspiciously like one of the patches you posted last
>> month, but missing some of the changes I suggested.
>>  
> Cor, blimey, guv'nor, you've got me banged to rights (serves me right
> for trying to tidy up my git repository).
>> +#(use-modules (ice-9 q))
>>
>> I can't see any procedures from this module in init.ly.
>>  
> Changed from another patch I was working on, reverted for this patch.
>> +#(define output-count 0)            % Now only used in regression tests
>>
>> This isn't user serviceable any more, so you might as well clear out
>> all remaining references to it (and the obsolete code).
>>  
> Removed.  The only remaining thing I could see in git which used it was
> a regression test where the whole lot of code was commented out
> (input/regression/backend-svg.ly).  Reinhold has already changed the
> regression test where it is actually used.
>> +(_i "Take the music in @var{part1} and @var{part2} and typeset so
>> that they share a staff")
>>
>> staff.")
>>
>> +(_i "Print a trill with @var{main-note} as the main note of the trill and
>>
>> trailing space, docstring goes after predicate list
>>
>> +print @var{secondary-note} as stemless note head in paretheses")
>>
>> parentheses.")
>>
>> +(_i "Indicate a section of music to be quoted.  @var{what} indicates the name
>>
>> trailing space, docstring goes after predicate list
>>
>> +of the quoted voice, as specified in a @code{\addquote} command.
>>
>> trailing spaces, @code{\\addQuote}
>>
>> +(_i "Set up a custom style of dash pattern for @var{dash-fraction} ratio of
>>
>> trailing space
>>
>> +(_i "Set up a custom style of dash pattern for @var{dash-fraction} ratio of
>>
>> trailing space
>>  
> All these are re-applied.
>> In all cases, the indentation needs fixing.
>>  
> Have run the code through the Frescobaldi indent tool.
>
> Now is it OK to push?
>
> Cheers,
> Ian
>
>
>
> ------------------------------------------------------------------------
>
> _______________________________________________
> lilypond-devel mailing list
> [hidden email]
> http://lists.gnu.org/mailman/listinfo/lilypond-devel

From a0d99140b6199199b846db9fa07a5b568a90b16d Mon Sep 17 00:00:00 2001
From: ian <[hidden email]>
Date: Fri, 23 Oct 2009 01:49:11 +0100
Subject: [PATCH] Add missing documentation strings to declarations in
 music-functions-init.ly.
 Redundant output-count parser variable removed

---
 ly/init.ly                 |    2 --
 ly/music-functions-init.ly |   20 +++++++++++++++-----
 ly/property-init.ly        |    7 +++++++
 3 files changed, 22 insertions(+), 7 deletions(-)

diff --git a/ly/init.ly b/ly/init.ly
index 9304810..5418b80 100644
--- a/ly/init.ly
+++ b/ly/init.ly
@@ -8,11 +8,9 @@
 
 \include "declarations-init.ly"
 
-
 #(ly:set-option 'old-relative #f)
 #(define toplevel-scores (list))
 #(define toplevel-bookparts (list))
-#(define output-count 0)
 #(define $defaultheader #f)
 #(define $current-book #f)
 #(define $current-bookpart #f)
diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly
index 718615a..a8a2ece 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))
 
@@ -449,8 +449,8 @@ 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
-markups), or inside a score.")
+   (_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
        'line-break-permission 'force
@@ -584,11 +584,14 @@ 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
+(_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?)
    (let*
@@ -622,6 +625,10 @@ pitchedTrill =
 
 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.  
+@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
@@ -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
+ @code{\\repeat 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 4983506..911c3ce 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
|

Re: [PATCH] : Supply missing documentation strings in music-function-init.ly

Neil Puttock
In reply to this post by Ian Hulin
2009/10/23 Ian Hulin <[hidden email]>:

> Cor, blimey, guv'nor, you've got me banged to rights (serves me right for
> trying to tidy up my git repository).

Heh, sometimes it's easier to delet the whole thing and start from scratch. :)

> Have run the code through the Frescobaldi indent tool.

Ooh, I wouldn't do that.  As much as I like using Frescobaldi, it's
not much use for indenting Scheme (yet).

> Now is it OK to push?

Not yet.

+              (string=? (ly:music-property mus 'quoted-context-id "") "cue"))

You've removed a hard tab, but now the indentation's out by a space.

+(_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)))

indentation (all three lines)

+(_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")

remove trailing space, indent, docstring in wrong position (must go
after predicate list, otherwise breaks compilation)

+(_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.
+@var{main-music} is used to indicate the length of music to be quoted;
+usually contains spacers or multi-measure rests.")

remove trailing spaces, indent, docstring in wrong position

+ @code{\\repeat percent} commands in @var{music} to be interpreted
+ as @code{\\repeat unfold}.")

remove spaces from beginning of lines

+(_i "Set up a custom style of dash pattern for @var{dash-fraction} ratio of

indent

+ line to space repeated at @var{dash-period} interval.")

remove space

+(_i "Enable generation of code in final-format (e.g. pdf) files to
reference the

indent

+ originating lilypond source statement;
+ this is helpful when developing a score but generates bigger
final-format files.")

remove spaces

+(_i "Suppress generating extra code in final-format (e.g. pdf)  files to point

indent, trailing space

+ back to the lilypond source statement.")

remove space

I've fixed all these issues in the attached patch, which you can use
for rebasing if you wish.

Cheers,
Neil

0002-Review-docstring-patch.patch (6K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: [PATCH] : Supply missing documentation strings in music-function-init.ly

Ian Hulin
Thanks for the feedback, Neil.  Is this OK to push now?

Cheers,

Ian

Neil Puttock wrote:
2009/10/23 Ian Hulin [hidden email]:

  
Cor, blimey, guv'nor, you've got me banged to rights (serves me right for
trying to tidy up my git repository).
    

Heh, sometimes it's easier to delet the whole thing and start from scratch. :)

  
Have run the code through the Frescobaldi indent tool.
    

Ooh, I wouldn't do that.  As much as I like using Frescobaldi, it's
not much use for indenting Scheme (yet).

  
Now is it OK to push?
    

Not yet.

+              (string=? (ly:music-property mus 'quoted-context-id "") "cue"))

You've removed a hard tab, but now the indentation's out by a space.

+(_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)))

indentation (all three lines)

+(_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")

remove trailing space, indent, docstring in wrong position (must go
after predicate list, otherwise breaks compilation)

+(_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.
+@var{main-music} is used to indicate the length of music to be quoted;
+usually contains spacers or multi-measure rests.")

remove trailing spaces, indent, docstring in wrong position

+ @code{\\repeat percent} commands in @var{music} to be interpreted
+ as @code{\\repeat unfold}.")

remove spaces from beginning of lines

+(_i "Set up a custom style of dash pattern for @var{dash-fraction} ratio of

indent

+ line to space repeated at @var{dash-period} interval.")

remove space

+(_i "Enable generation of code in final-format (e.g. pdf) files to
reference the

indent

+ originating lilypond source statement;
+ this is helpful when developing a score but generates bigger
final-format files.")

remove spaces

+(_i "Suppress generating extra code in final-format (e.g. pdf)  files to point

indent, trailing space

+ back to the lilypond source statement.")

remove space

I've fixed all these issues in the attached patch, which you can use
for rebasing if you wish.

Cheers,
Neil


______________________________________________        
This email has been scanned by Netintelligence        
http://www.netintelligence.com/email
  


From 48d7cf640be9b78b398bc61d00aedbaa795cf540 Mon Sep 17 00:00:00 2001
From: Ian Hulin <[hidden email]>
Date: Sun, 25 Oct 2009 22:42:37 +0000
Subject: [PATCH] [PATCH] Add missing documentation strings in property-init.ly and
  music-functions-init.ly.

---
 ly/music-functions-init.ly |   22 ++++++++++++++++------
 ly/property-init.ly        |   10 +++++++++-
 2 files changed, 25 insertions(+), 7 deletions(-)

diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly
index 718615a..4283157 100644
--- a/ly/music-functions-init.ly
+++ b/ly/music-functions-init.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 =
 #(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 a stemless note head in parentheses.")
    (let*
        ((get-notes (lambda (ev-chord)
      (filter
@@ -622,8 +625,12 @@ pitchedTrill =
 
 quoteDuring =
 #(define-music-function
-  (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 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.")
   (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
+@code{\\repeat 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 4983506..a73848e 100644
--- a/ly/property-init.ly
+++ b/ly/property-init.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 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
|

Re: [PATCH] : Supply missing documentation strings in music-function-init.ly

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

Sure is.

Thanks,
Neil

---

----
Join the Frogs!

Reply | Threaded
Open this post in threaded view
|

Re: [PATCH] : Supply missing documentation strings in music-function-init.ly

Ian Hulin
Neil Puttock wrote:
> 2009/10/25 Ian Hulin <[hidden email]>:
>> Thanks for the feedback, Neil.  Is this OK to push now?
>
> Sure is.
>
> Thanks,
> Neil
Woo-hoo, green light! Could someone with the relevant privileges push
this to the main git repository, please?

Cheers,

Ian

From 48d7cf640be9b78b398bc61d00aedbaa795cf540 Mon Sep 17 00:00:00 2001
From: Ian Hulin <[hidden email]>
Date: Sun, 25 Oct 2009 22:42:37 +0000
Subject: [PATCH] [PATCH] Add missing documentation strings in property-init.ly and
  music-functions-init.ly.

---
 ly/music-functions-init.ly |   22 ++++++++++++++++------
 ly/property-init.ly        |   10 +++++++++-
 2 files changed, 25 insertions(+), 7 deletions(-)

diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly
index 718615a..4283157 100644
--- a/ly/music-functions-init.ly
+++ b/ly/music-functions-init.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 =
 #(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 a stemless note head in parentheses.")
    (let*
        ((get-notes (lambda (ev-chord)
      (filter
@@ -622,8 +625,12 @@ pitchedTrill =
 
 quoteDuring =
 #(define-music-function
-  (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 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.")
   (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
+@code{\\repeat 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 4983506..a73848e 100644
--- a/ly/property-init.ly
+++ b/ly/property-init.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 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
|

Re: [PATCH] : Supply missing documentation strings in music-function-init.ly

Carl Sorensen
Neil already pushed it yesterday.

Thanks,

Carl


On 10/26/09 12:47 PM, "Ian Hulin" <[hidden email]> wrote:

> Neil Puttock wrote:
>> 2009/10/25 Ian Hulin <[hidden email]>:
>>> Thanks for the feedback, Neil.  Is this OK to push now?
>>
>> Sure is.
>>
>> Thanks,
>> Neil
> Woo-hoo, green light! Could someone with the relevant privileges push
> this to the main git repository, please?
>
> Cheers,
>
> Ian


---

----
Join the Frogs!