From f1d34682d29f5c714cb4b02221043da5ae1e659c Mon Sep 17 00:00:00 2001 From: Kieren Date: Fri, 13 Mar 2009 11:12:29 -0400 Subject: [PATCH] Add docstrings to functions in music-functions-init.ly; from Kieren. (cherry picked from commit a9588406a7bee1d45f5049296f0e76a47606ca9b) --- ly/music-functions-init.ly | 11 ++++++----- ly/predefined-fretboards-init.ly | 6 ++---- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/ly/music-functions-init.ly b/ly/music-functions-init.ly index 011265eaeb..2dded22e3d 100644 --- a/ly/music-functions-init.ly +++ b/ly/music-functions-init.ly @@ -649,15 +649,16 @@ resetRelativeOctave = scaleDurations = -#(define-music-function - (parser location fraction music) (number-pair? ly:music?) - (ly:music-compress music (ly:make-moment (car fraction) (cdr fraction)))) +#(define-music-function (parser location fraction music) (number-pair? ly:music?) + (_i "Multiply the duration of events in @var{music} by @var{fraction}.") + (ly:music-compress music + (ly:make-moment (car fraction) (cdr fraction)))) shiftDurations = #(define-music-function (parser location dur dots arg) (integer? integer? ly:music?) - (_i "") + (_i "Scale @var{arg} up by a factor of @var{2^dur*(2-(1/2)^dots)}.") (music-map (lambda (x) @@ -677,7 +678,7 @@ the `parameters' assoc list.") rightHandFinger = #(define-music-function (parser location finger) (number-or-string?) - (_i "Define a StrokeFingerEvent") + (_i "Apply @var{finger} as a fingering indication.") (apply make-music (append diff --git a/ly/predefined-fretboards-init.ly b/ly/predefined-fretboards-init.ly index 35a6e7560d..d0f861a402 100644 --- a/ly/predefined-fretboards-init.ly +++ b/ly/predefined-fretboards-init.ly @@ -37,9 +37,8 @@ hash with the key @var{(cons key-symbol tuning)}.") storePredefinedDiagram = #(define-music-function (parser location chord tuning diagram-definition) (ly:music? pair? string-or-pair?) - "Add predefined fret diagram defined by @code{diagram-definition} -for the chord pitches @code{chord} and -the stringTuning @code{tuning}." + (_i "Add predefined fret diagram defined by @var{diagram-definition} + for the chord pitches @var{chord} and the stringTuning @var{tuning}.") (let* ((pitches (event-chord-pitches (car (extract-named-music chord 'EventChord)))) (hash-key (cons tuning pitches)) @@ -50,4 +49,3 @@ the stringTuning @code{tuning}." hash-key verbose-definition)) (make-music 'SequentialMusic 'void #t)) - -- 2.39.2