Re: [frogs] updated patches

[Andrew Hawryluk <ahawryluk@xxxxxxxxx>]

On Sat, Jan 17, 2009 at 12:25 PM, Carl D. Sorensen <c_sorensen@xxxxxxx> wrote:
> On 1/17/09 10:09 AM, "Andrew Hawryluk" <ahawryluk@xxxxxxxxx> wrote:
>> Here's my docstrings with the @var references. Thanks for your help, Carl!
>
> oops -- no patch attached.
>

Second attempt at attaching files.
Andrew

From 26e97b064a5ce5a1fec7e31114bc6496f9ed6d26 Mon Sep 17 00:00:00 2001
From: andrew <andrew@obi-wan.(none)>
Date: Fri, 9 Jan 2009 12:18:48 -0700
Subject: [PATCH] Added docstrings

---
 ly/music-functions-init.ly       |   12 ++++++++----
 ly/predefined-fretboards-init.ly |    4 ++--
 2 files changed, 10 insertions(+), 6 deletions(-)

diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly
index a112b67..1a27967 100644
--- a/ly/music-functions-init.ly
+++ b/ly/music-functions-init.ly
@@ -12,11 +12,12 @@
 #(use-modules (srfi srfi-1))
 
 acciaccatura =
-#(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic)
+#(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic
+   (_i "Create an acciaccatura"))
 
 addQuote =
 #(define-music-function (parser location name music) (string? ly:music?)
-   (_i "Add a piece of music to be quoted ")
+   (_i "Add a piece of music to be quoted")
    (add-quotable parser name music)
    (make-music 'SequentialMusic 'void #t))
 
@@ -27,7 +28,7 @@ afterGrace =
 #(define-music-function
   (parser location main grace)
   (ly:music? ly:music?)
-
+  (_i "Create grace note(s) after a main music expression.")
   (let*
       ((main-length (ly:music-length main))
        (fraction  (ly:parser-lookup parser 'afterGraceFraction)))
@@ -50,6 +51,7 @@ afterGrace =
 
 applyMusic =
 #(define-music-function (parser location func music) (procedure? ly:music?)
+               (_i"Apply a given function to a music expression")
                (func music))
 
 
@@ -93,6 +95,8 @@ autochange =
 
 applyContext =
 #(define-music-function (parser location proc) (procedure?)
+                 (_i"Modify context properties procedurally.
+ Applications include: checking bar numbers, smart octavation.")
                  (make-music 'ApplyContext 
                    'origin location
                    'procedure proc))
@@ -244,7 +248,7 @@ grace =
 addInstrumentDefinition =
 #(define-music-function
    (parser location name lst) (string? list?)
-
+   (_i"Create a detailed list of the necessary changes for use with instrumentSwitch")
    (set! instrument-definitions (acons name lst instrument-definitions))
 
    (make-music 'SequentialMusic 'void #t))
diff --git a/ly/predefined-fretboards-init.ly b/ly/predefined-fretboards-init.ly
index df88ee7..5ee0ca6 100644
--- a/ly/predefined-fretboards-init.ly
+++ b/ly/predefined-fretboards-init.ly
@@ -21,8 +21,8 @@
 addChordShape =
 #(define-music-function (parser location key-symbol tuning shape-definition)
    (symbol? pair? string-or-pair?)
-   "Add chord shape @code{shape-definition} to the @code{chord-shape-table}
-hash with the key @code{(cons key-symbol tuning)}."
+   (_i "Add chord shape @code{shape-definition} to the @code{chord-shape-table}
+hash with the key @code{(cons key-symbol tuning)}.")
    (hash-set! chord-shape-table
                (cons key-symbol tuning)
                shape-definition)
-- 
1.5.4.3

From 66debbf146ce9d92b385563bdfd9a65eef2c4d01 Mon Sep 17 00:00:00 2001
From: andrew <andrew@obi-wan.(none)>
Date: Sat, 17 Jan 2009 10:06:37 -0700
Subject: [PATCH] Docs: added @var to 8 doc strings

---
 ly/music-functions-init.ly       |   14 ++++++++------
 ly/predefined-fretboards-init.ly |    4 ++--
 2 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly
index 1a27967..705641f 100644
--- a/ly/music-functions-init.ly
+++ b/ly/music-functions-init.ly
@@ -13,11 +13,12 @@
 
 acciaccatura =
 #(def-grace-function startAcciaccaturaMusic stopAcciaccaturaMusic
-   (_i "Create an acciaccatura"))
+   (_i "Create an acciaccatura where @var{startAcciaccaturaMusic} contains
+ the grace notes and a slur extends to @var{stopAcciaccaturaMusic)"))
 
 addQuote =
 #(define-music-function (parser location name music) (string? ly:music?)
-   (_i "Add a piece of music to be quoted")
+   (_i "Add a piece of @var{music} to be quoted and give it a @var{name}")
    (add-quotable parser name music)
    (make-music 'SequentialMusic 'void #t))
 
@@ -28,7 +29,7 @@ afterGrace =
 #(define-music-function
   (parser location main grace)
   (ly:music? ly:music?)
-  (_i "Create grace note(s) after a main music expression.")
+  (_i "Create @var{grace} note(s) after a @var{main} music expression.")
   (let*
       ((main-length (ly:music-length main))
        (fraction  (ly:parser-lookup parser 'afterGraceFraction)))
@@ -51,7 +52,7 @@ afterGrace =
 
 applyMusic =
 #(define-music-function (parser location func music) (procedure? ly:music?)
-               (_i"Apply a given function to a music expression")
+               (_i"Apply a given function, @var{func}, to a @var{music} expression")
                (func music))
 
 
@@ -95,7 +96,7 @@ autochange =
 
 applyContext =
 #(define-music-function (parser location proc) (procedure?)
-                 (_i"Modify context properties procedurally.
+                 (_i"Modify context properties with a @var{procedure}.
  Applications include: checking bar numbers, smart octavation.")
                  (make-music 'ApplyContext 
                    'origin location
@@ -248,7 +249,8 @@ grace =
 addInstrumentDefinition =
 #(define-music-function
    (parser location name lst) (string? list?)
-   (_i"Create a detailed list of the necessary changes for use with instrumentSwitch")
+   (_i"Create a detailed @var{list} of the necessary changes for use with
+ instrumentSwitch and give it a @var{name}")
    (set! instrument-definitions (acons name lst instrument-definitions))
 
    (make-music 'SequentialMusic 'void #t))
diff --git a/ly/predefined-fretboards-init.ly b/ly/predefined-fretboards-init.ly
index 5ee0ca6..544f9fd 100644
--- a/ly/predefined-fretboards-init.ly
+++ b/ly/predefined-fretboards-init.ly
@@ -21,8 +21,8 @@
 addChordShape =
 #(define-music-function (parser location key-symbol tuning shape-definition)
    (symbol? pair? string-or-pair?)
-   (_i "Add chord shape @code{shape-definition} to the @code{chord-shape-table}
-hash with the key @code{(cons key-symbol tuning)}.")
+   (_i "Add chord shape @var{shape-definition} to the @var{chord-shape-table}
+hash with the key @var{(cons key-symbol tuning)}.")
    (hash-set! chord-shape-table
                (cons key-symbol tuning)
                shape-definition)
-- 
1.5.4.3