[frogs] Assignment #1

[ Thread Index | Date Index | More lilynet.net/frogs Archives ]


Hi Carl et al.,

Here's my eight doc strings, including one that will require the new
def-grace-function.

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



Mail converted by MHonArc 2.6.19+ http://listengine.tuxfamily.org/