From: Carl Sorensen <c_sorensen@byu.edu>
Date: Thu, 8 Jan 2009 18:17:30 +0000 (-0700)
Subject: Change docstrings for microtonal music
X-Git-Tag: release/2.12.2-1~42^2~2
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=ba93abba97c5aade108ff8d736d34124ccf1539d;p=lilypond.git

Change docstrings for microtonal music

Update the documentation strings for microtonal music, according
to recommendations made by Graham Breed.

Patches created by Jonathan Kulp.

Patches applied by Carl Sorensen.
---

diff --git a/Documentation/user/input.itely b/Documentation/user/input.itely
index 3f4eb2fc32..f290a3370e 100644
--- a/Documentation/user/input.itely
+++ b/Documentation/user/input.itely
@@ -1604,7 +1604,7 @@ The following items of notation are reflected in the MIDI output:
 
 @itemize
 @item Pitches
-@item Quarter tones (See @ref{Accidentals}. Rendering needs a
+@item Microtones (See @ref{Accidentals}. Rendering needs a
 player that supports pitch bend.)
 @item Chords entered as chord names
 @item Rhythms entered as note durations, including tuplets
@@ -1630,6 +1630,7 @@ The following items of notation have no effect on the MIDI output:
 @item Crescendi, decrescendi over a single note
 @item Tremolos entered with @q{@code{:}[@var{number}]}
 @item Figured bass
+@item Microtonal chords
 @end itemize
 
 
diff --git a/lily/pitch-scheme.cc b/lily/pitch-scheme.cc
index 6ad6f8c89a..1ecc247ed1 100644
--- a/lily/pitch-scheme.cc
+++ b/lily/pitch-scheme.cc
@@ -25,10 +25,11 @@ LY_DEFINE (ly_pitch_transpose, "ly:pitch-transpose",
 LY_DEFINE (ly_make_pitch, "ly:make-pitch",
 	   2, 1, 0, (SCM octave, SCM note, SCM alter),
 	   "@var{octave} is specified by an integer, zero for the octave"
-	   " containing middle@tie{}C.  @var{note} is a number from 0"
-	   " to@tie{}6, with 0 corresponding to pitch@tie{}C and 6"
-	   " corresponding to pitch@tie{}B.  @var{alter} is a rational"
-	   " number of whole tones for alteration.")
+	   " containing middle@tie{}C. @var{note} is a number indexing the"
+	   " global default scale, with 0 corresponding to pitch@tie{}C"
+	   " and 6 usually corresponding to pitch@tie{}B. @var{alter} is" 
+	   " a rational number of 200-cent whole tones for alteration.")
+
 {
   LY_ASSERT_TYPE (scm_is_integer, octave, 1);
   LY_ASSERT_TYPE (scm_is_integer, note, 2);
diff --git a/lily/scale.cc b/lily/scale.cc
index 2c5ca19102..c1f9a81f05 100644
--- a/lily/scale.cc
+++ b/lily/scale.cc
@@ -20,7 +20,8 @@ LY_DEFINE (ly_make_scale, "ly:make-scale",
 	   1, 0, 0, (SCM steps),
 	   "Create a scale."
 	   "  The argument is a vector of rational numbers, each of which"
-	   " represents the number of tones of a pitch above the tonic.")
+	   " represents the number of 200 cent tones of a pitch above the"
+	   " tonic.")
 {
   bool type_ok = scm_is_vector (steps);
 
@@ -66,7 +67,12 @@ Scale * default_global_scale = 0;
 
 LY_DEFINE (ly_set_default_scale, "ly:set-default-scale",
 	   1, 0, 0, (SCM scale),
-	   "Set the global default scale.")
+	   "Set the global default scale. This determines the tuning of"
+	   " pitches with no accidentals or key signatures.  The first"
+	   " pitch is C. Alterations are calculated relative to this"
+	   " scale.  The number of pitches in this scale determines the"
+	   " number of scale steps that make up an octave.  Usually the"
+	   " 7-note major scale.")
 {
   LY_ASSERT_SMOB (Scale, scale, 1);