From 10797f7ffce22aa5cf67e81abdc5116a9132f879 Mon Sep 17 00:00:00 2001 From: Graham Percival Date: Thu, 17 Jan 2008 16:47:03 -0800 Subject: [PATCH] Misc minor updates. --- Documentation/user/macros.itexi | 4 +++- Documentation/user/tutorial.itely | 23 ++++++++++++++++------- Documentation/user/writing-texinfo.txt | 2 ++ 3 files changed, 21 insertions(+), 8 deletions(-) diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index da2897b7a4..bbeddc2433 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -54,7 +54,8 @@ @macro commonprop @noindent -@subsubheading Commonly tweaked properties +@c @subsubheading Commonly tweaked properties +@subsubheading Selected Snippets @end macro @@ -62,6 +63,7 @@ @noindent @subsubheading See also +@indent @end macro @macro refbugs diff --git a/Documentation/user/tutorial.itely b/Documentation/user/tutorial.itely index 1f28020a90..3e76b025e2 100644 --- a/Documentation/user/tutorial.itely +++ b/Documentation/user/tutorial.itely @@ -472,13 +472,22 @@ a comment is a remark for the human reader of the music input; it is ignored while parsing, so it has no effect on the printed output. There are two types of comments. The percent symbol @code{%} introduces a line comment; anything after @code{%} on -that line is ignored. A block comment marks a whole section of -music input as a comment. Anything that is enclosed in @code{%@{} -and @code{%@}} is ignored. However, block comments do not @q{nest}. -This means that you cannot place a block comment inside another -block comment. If you try, the first @code{%@}} will terminate -@emph{both} block comments. The following -fragment shows possible uses for comments: +that line is ignored. By convention, a line comment is placed +@emph{above} the code it refers to. + +@example +a4 a a a +% this comment refers to the Bs +b2 b +@end example + +A block comment marks a whole section of music input as a comment. +Anything that is enclosed in @code{%@{} and @code{%@}} is ignored. +However, block comments do not @q{nest}. This means that you +cannot place a block comment inside another block comment. If you +try, the first @code{%@}} will terminate @emph{both} block +comments. The following fragment shows possible uses for +comments: @example % notes for twinkle twinkle follow diff --git a/Documentation/user/writing-texinfo.txt b/Documentation/user/writing-texinfo.txt index cede0fe797..11f49990c5 100644 --- a/Documentation/user/writing-texinfo.txt +++ b/Documentation/user/writing-texinfo.txt @@ -157,6 +157,8 @@ commands. %%%%% SYNTAX SURVEY @c - single line comments + "@c NOTE:" is a comment which should remain in the final + version. (gp only command ;) @ignore ... @end ignore - multi-line comment @cindex - General index. Please add as many as you can. Don't -- 2.39.2