Re: [patch #6829] Tutorial documentation

[John Darrington]

On Sat, May 16, 2009 at 06:13:28PM +0000, Ben Pfaff wrote:
     
     One piece of general advice that I don't see here is to use the GUI to
     generate code with the "Paste" command and then reuse the generated code.
     
This tutorial is written around the command line interface, per Brian
Gough's wishes.  It mentions the GUI only in passing.


     The first and third patch hunks in expressions.texi misalign menu item
     descriptions.

I fixed this.


     
     Is the term "graphic user interface" correct?  I usually see the first word
     written as "graphical".  I guess that could be an Americanism.

I've heard both terms, which I think are synonymous. "Graphic" and
"graphical" are both adjectives meaning "drawn, or relating to
pictures".  I prefer "graphic", since it's easier to say, but I don't
have any strong feelings about it.
     
     The patch adds a line "@include doc/tut.texi" to the new file
     doc/tutorial.texi, but I don't see a tut.texi in the patch.

tut.texi is a generated file.
     
     It might be worth saying explicitly that the doubled "list" in "data list
     list" is not a typo.

Done.
     
     I think that the * in your data list examples may be left out entirely.

Done.
     
     >For a complete description of the @cmd{LIST} command, @pxref{LIST}.
     
     @pxref is normally used only inside parentheses.  I would write this as 
"...,
     see @ref{LIST}."  I see other instances of this elsewhere.

According to the Texinfo manual, @pxref "is best used at the end of a
sentence or before a closing parenthesis".  Although it later mentions
that in previous versions it was only permitted within parentheses.
     
     I got confused about the "height" variables.  Early on in the "listing the
     data" section the heights appeared to be in centimeters.  Later on in the
     "data screening and transformation" section they were in millimeters.  Now
     admittedly these are different data files but I still found it
     surprising.

I changed them all to mm.
     
-- 
PGP Public key ID: 1024D/2DE827B3 
fingerprint = 8797 A26D 0854 2EAB 0285  A290 8A67 719C 2DE8 27B3
See http://pgp.mit.edu or any PGP keyserver for public key.

signature.asc
Description: Digital signature