Re: A bit of rectification for learning/tweaks regarding Scheme values (issue 6868063)

[dak]

Reviewers: Trevor Daniels,


https://codereview.appspot.com/6868063/diff/1/Documentation/learning/tweaks.itely
File Documentation/learning/tweaks.itely (right):

https://codereview.appspot.com/6868063/diff/1/Documentation/learning/tweaks.itely#newcode902
Documentation/learning/tweaks.itely:902: @extending{Calculations in
Scheme}.
On 2012/12/04 21:37:12, Trevor Daniels wrote:
> @rextend

That's a rather major quibble.

https://codereview.appspot.com/6868063/diff/1/Documentation/learning/tweaks.itely#newcode925
Documentation/learning/tweaks.itely:925: symbol names, enclosed in
parentheses.
On 2012/12/04 21:37:12, Trevor Daniels wrote:
> Drop the comma to make it clear the apostrophe is
> outside the parentheses or (my preference) use the
> original sentence construction to preserve the same
> form as the other entries.

Huh.  This started out as "Constant lists ...", and then I moved the
constant qualification before the whole table.  You are right that the
remaining change is somewhat pointless.

https://codereview.appspot.com/6868063/diff/1/Documentation/learning/tweaks.itely#newcode937
Documentation/learning/tweaks.itely:937: @tab Any positive or negative,
possibly decimal value
On 2012/12/04 21:37:12, Trevor Daniels wrote:
> , possibly decimal,

Definitely not.  "direction" is checked by ly:dir?, and ly:dir? _only_
permits -1, 0, 1, and nothing else.  "possibly decimal" is definitely
wrong.  Where an inter/extra-polating value _based_ on directions is
permitted, you will find the number? predicate instead.

https://codereview.appspot.com/6868063/diff/1/Documentation/learning/tweaks.itely#newcode952
Documentation/learning/tweaks.itely:952: @tab A constant vector can be
written by writing constants
On 2012/12/04 21:37:12, Trevor Daniels wrote:
> I'd prefer the same form as the other entries,
> just stating what it is, rather than how it might
> be constructed.

That is not what was written there before.

Description:
A bit of rectification for learning/tweaks regarding Scheme values

Please review this at https://codereview.appspot.com/6868063/

Affected files:
  M Documentation/learning/tweaks.itely


Index: Documentation/learning/tweaks.itely
diff --git a/Documentation/learning/tweaks.itely  
b/Documentation/learning/tweaks.itely
index  
cce7c46698b9112862822deb62b2d426cf9c417e..2ae4030866462fa40851c41081a627b68d3a6160  
100644
--- a/Documentation/learning/tweaks.itely
+++ b/Documentation/learning/tweaks.itely
@@ -897,7 +897,9 @@ property name in the IR.  Here is a list of the types  
you may
 need, together with the rules for that type, and some examples.
 You must always add a hash symbol, @code{#}, of course,
 to the front of these values when they are entered in the
address@hidden command.
address@hidden command.  We only give examples for constants
+here: if you want to compute a value using Scheme, see
address@hidden in Scheme}.

 @multitable @columnfractions .2 .45 .35
 @headitem Property type
@@ -907,32 +909,33 @@ to the front of these values when they are entered in  
the
   @tab Either True or False, represented by #t or #f
   @tab @code{#t}, @code{#f}
 @item Dimension (in staff space)
-  @tab A positive decimal number (in units of staff space)
+  @tab A decimal number (in units of staff space)
   @tab @code{2.5}, @code{0.34}
 @item Direction
-  @tab A valid direction constant or its numerical equivalent (decimal
-values between -1 and 1 are allowed)
+  @tab A valid direction constant or its numerical equivalent
+  (@code{0} or @code{CENTER} indicate a neutral direction)
   @tab @code{LEFT}, @code{CENTER}, @code{UP},
        @code{1}, @address@hidden
 @item Integer
-  @tab A positive whole number
-  @tab @code{3}, @code{1}
+  @tab A whole number
+  @tab @code{3}, @code{-1}
 @item List
-  @tab A set of values separated by spaces, enclosed in parentheses
-and preceded by an apostrophe
-  @tab @code{'(left-edge staff-bar)}, @code{'(1)},
+  @tab Lists can be specified by an apostrophe (quote
+  mark) followed by a sequence of constants or
+  symbol names, enclosed in parentheses.
+  @tab @code{'(left-edge staff-bar)}, @code{'(1)}, @code{'()},
        @code{'(1.0 0.25 0.5)}
 @item Markup
   @tab Any valid markup
-  @tab @code{\markup @{ \italic "cresc." @}}
+  @tab @code{\markup @{ \italic "cresc." @}}, @code{"bagpipe"}
 @item Moment
   @tab A fraction of a whole note constructed with the
 make-moment function
-  @tab @code{(ly:make-moment 1 4)},
-       @code{(ly:make-moment 3 8)}
+  @tab @code{(ly:make-moment 1/4)},
+       @code{(ly:make-moment 3/8)}
 @item Number
-  @tab Any positive or negative decimal value
-  @tab @code{3.5}, @address@hidden
+  @tab Any positive or negative, possibly decimal value
+  @tab @code{3}, @address@hidden
 @item Pair (of numbers)
   @tab Two numbers separated by a @q{space . space} and enclosed
 in brackets preceded by an apostrophe
@@ -946,9 +949,9 @@ preceded by an apostrophe
   @tab @code{bend::print}, @code{ly:text-interface::print},
        @code{#f}
 @item Vector
-  @tab A list of three items enclosed in parentheses and preceded
-by apostrophe-hash, @code{'#}.
-  @tab @code{'#(#t #t #f)}
+  @tab A constant vector can be written by writing constants
+  enclosed in @code{#(address@hidden@code{)}.
+  @tab @code{#(#t #t #f)}
 @end multitable