]> git.donarmstrong.com Git - lilypond.git/commitdiff
More GDP tips.
authorGraham Percival <graham@percival-music.ca>
Fri, 21 Sep 2007 23:26:05 +0000 (16:26 -0700)
committerJohn Mandereau <john.mandereau@gmail.com>
Fri, 2 Nov 2007 08:39:16 +0000 (09:39 +0100)
Documentation/user/README.txt

index d2480a0939cc8f35a8c3dbed9ada208d5e19a0a8..293d35abde5d0d21518b2b7619cd33db1d5d8fc8 100644 (file)
@@ -80,6 +80,12 @@ highly recommended.
 
 * Use two spaces after a period.
 
+* Don't use a @ref{link to another section} in the middle of a
+  sentence.  It looks ok in HTML, moderately bad in PDF, and
+  utterly horrible in INFO.  Instead, reword the sentence so that
+  users are encouraged to see @ref{link to another section}.
+  (at the end of the sentence)
+
 * Variables or numbers which consist of a single character
   (probably followed by a punctuation mark) should be tied
   properly, either to the previous or the next word.  Example:
@@ -135,8 +141,8 @@ highly recommended.
   all such characters appear in all output formats.
 
 * Lines should be less than 72 characters long.  (I personally
-  recommend writing with 66-char lines, but don't bother changing
-  this if you see long lines.)
+  recommend writing with 66-char lines, but don't bother modifying
+  existing material.)
 
 * Use @q instead of `...' and @qq instead of ``...''.  The latter macro
   should be used with care since we use `...' as the default quoting