Hello list, while working on issue 1135 (which is closed now!) I found out that some functions still lack a proper doc string. Attached is a patch which adds the missing (_i ...) to four of them.
Some functions concerning the string tunings are still not documented; IIUC, David Katrup has posted some improvements recently that allow for a better syntax in this area, so I didn't add a doc string here. Please correct me if my english is too clumsy. To describe harmonics in a concise way is not so easy (for me) as it seemed at first glance. Regards, Marc
From 54be171eae574d836b7cb24d67ec64fe19b8ca78 Mon Sep 17 00:00:00 2001 From: Marc Hohl <[email protected]> Date: Wed, 14 Sep 2011 20:23:13 +0200 Subject: [PATCH] Doc: adding doc strings for \...DashPattern and \harmonicBy... --- ly/music-functions-init.ly | 5 +++++ ly/property-init.ly | 6 +++++- 2 files changed, 10 insertions(+), 1 deletions(-) diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly index ba8aa76..f513be3 100644 --- a/ly/music-functions-init.ly +++ b/ly/music-functions-init.ly @@ -402,6 +402,8 @@ grace = (_i "Insert @var{music} as grace notes.")) harmonicByFret = #(define-music-function (parser location fret music) (number? ly:music?) + (_i "Convert @var{music} into harmonics; the resulting notes resemble +harmonics played on a fretted instrument by touching the strings above @var{fret}.") (let* ((fret (number->string fret)) (pitch (fret->pitch fret))) (make-sequential-music @@ -416,6 +418,9 @@ harmonicByFret = #(define-music-function (parser location fret music) (number? l #})))) harmonicByRatio = #(define-music-function (parser location ratio music) (number? ly:music?) + (_i "Convert @var{music} into harmonics; the resulting notes resemble +harmonics played on a fretted instrument by touching the strings above the point +given through @var{ratio}.") (let ((pitch (ratio->pitch ratio)) (fret (ratio->fret ratio))) (make-sequential-music diff --git a/ly/property-init.ly b/ly/property-init.ly index 02acc1b..fe9447e 100644 --- a/ly/property-init.ly +++ b/ly/property-init.ly @@ -307,7 +307,7 @@ 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.") +line to space repeated at @var{dash-period} interval for phrasing slurs.") #{ \override PhrasingSlur #'dash-definition = $(make-simple-dash-definition dash-fraction dash-period) @@ -391,6 +391,8 @@ slurNeutral = \revert Slur #'direction slurDashPattern = #(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 for slurs.") #{ \override Slur #'dash-definition = $(make-simple-dash-definition dash-fraction dash-period) @@ -510,6 +512,8 @@ tieNeutral = \revert Tie #'direction tieDashPattern = #(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 for ties.") #{ \override Tie #'dash-definition = $(make-simple-dash-definition dash-fraction dash-period) -- 1.7.4.1
_______________________________________________ lilypond-devel mailing list [email protected] https://lists.gnu.org/mailman/listinfo/lilypond-devel
