[PATCH]: Add missing docstrings in music-functions-init.ly

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

[PATCH]: Add missing docstrings in music-functions-init.ly

Ian Hulin
I found three functions with missing docstrings.  Patch attached.

Cheers,

Ian Hulin

From 2b427f62d1061692a035d11fc2943a07fe909c30 Mon Sep 17 00:00:00 2001
From: Ian Hulin <ian@nanny-ogg.(none)>
Date: Fri, 11 Sep 2009 22:46:41 +0100
Subject: [PATCH] Add three functions with missing documentation strings:
 partcombine,
 pitchedTrill
 quoteDuring

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

diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly
index a57a17b..2cc0e5e 100644
--- a/ly/music-functions-init.ly
+++ b/ly/music-functions-init.ly
@@ -583,11 +583,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*
@@ -621,6 +624,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
--
1.6.0.4

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

Re: [PATCH]: Add missing docstrings in music-functions-init.ly

Neil Puttock
2009/9/11 Ian Hulin <[hidden email]>:
> I found three functions with missing docstrings.  Patch attached.

Thanks, Ian.

Just a few nitpicks:

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

full stop here

>  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")

and here

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

\\addquote

Regards,
Neil

---

----
Join the Frogs!

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

Re: [PATCH]: Add missing docstrings in music-functions-init.ly

Neil Puttock
2009/9/12 Neil Puttock <[hidden email]>:

> Just a few nitpicks:

Oops, one more I missed:

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

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

The docstrings should come after the type predicate lists.

Cheers,
Neil

---

----
Join the Frogs!

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

Re: [PATCH]: Add missing docstrings in music-functions-init.ly

Ian Hulin
Full stops added and docstrings moved.  Amended patch attached.

Cheers,

Ian

Neil Puttock wrote:
2009/9/12 Neil Puttock [hidden email]:

  
Just a few nitpicks:
    

Oops, one more I missed:

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

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

The docstrings should come after the type predicate lists.

Cheers,
Neil

---

----
Join the Frogs!


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


  


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

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

Re: [PATCH]: Add missing docstrings in music-functions-init.ly

Neil Puttock
2009/9/13 Ian Hulin <[hidden email]>:
> Full stops added and docstrings moved.  Amended patch attached.

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

typo has slipped in here: @var{what}

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

I forgot, it should be addQuote (IIRC it was originally called
addquote, but was changed; this docstring must have been missed).

There are a few lines with trailing spaces; if you can sort these out
together with the above nitpicks, I think it'll be ready for applying.

Thanks,
Neil

---

----
Join the Frogs!

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

Re: [PATCH]: Add missing docstrings in music-functions-init.ly

Ian Hulin
Neil Puttock wrote:
2009/9/13 Ian Hulin [hidden email]:
  
Full stops added and docstrings moved.  Amended patch attached.
    

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

typo has slipped in here: @var{what}

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

I forgot, it should be addQuote (IIRC it was originally called
addquote, but was changed; this docstring must have been missed).

There are a few lines with trailing spaces; if you can sort these out
together with the above nitpicks, I think it'll be ready for applying.

Thanks,
Neil

---

----
Join the Frogs!


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


  


From f886580073ce4bc47735f27e2a5ebddf366ab428 Mon Sep 17 00:00:00 2001
From: ian <[hidden email]>
Date: Sun, 13 Sep 2009 23:37:52 +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 |   11 ++++++-----
 ly/property-init.ly        |    7 +++++++
 2 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly
index 9085ed8..525708d 100644
--- a/ly/music-functions-init.ly
+++ b/ly/music-functions-init.ly
@@ -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,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]: Add missing docstrings in music-functions-init.ly

Neil Puttock
Hi Ian,

This is a different patch; can you post the original one?

Thanks,
Neil

---

----
Join the Frogs!

Loading...