Browse Source

org.texi: Update COMMENT keyword documentation

* doc/org.texi (Comment lines):
* doc/orgguide.texi (Comment lines): Update COMMENT keyword
  documentation.  Small tense changes.
Nicolas Goaziou 11 năm trước cách đây
mục cha
commit
e84c1d8442
2 tập tin đã thay đổi với 16 bổ sung9 xóa
  1. 8 5
      doc/org.texi
  2. 8 4
      doc/orgguide.texi

+ 8 - 5
doc/org.texi

@@ -9751,13 +9751,16 @@ a horizontal line.
 @cindex #+BEGIN_COMMENT
 
 Lines starting with zero or more whitespace characters followed by one
-@samp{#} and a whitespace are treated as comments and will never be exported.
+@samp{#} and a whitespace are treated as comments and, as such, are not
+exported.
 
-Also entire subtrees starting with the keyword @samp{COMMENT} will never be
-exported (and included code blocks will not be executed on export).
+Likewise, regions surrounded by @samp{#+BEGIN_COMMENT}
+... @samp{#+END_COMMENT} are not exported.
 
-Finally, regions surrounded by @samp{#+BEGIN_COMMENT}
-... @samp{#+END_COMMENT} will not be exported.
+Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any
+other keyword or priority cookie, comments out the entire subtree.  In this
+case, the subtree is not exported and no code block within it is executed
+either.  The command below helps changing the comment status of a headline.
 
 @table @kbd
 @kindex C-c ;

+ 8 - 4
doc/orgguide.texi

@@ -2169,10 +2169,14 @@ consisting of only dashes, and at least 5 of them.
 @subheading Comment lines
 
 Lines starting with zero or more whitespace characters followed by @samp{#}
-and a whitespace are treated as comments and will never be exported.  Also
-entire subtrees starting with the word @samp{COMMENT} will never be exported.
-Finally, regions surrounded by @samp{#+BEGIN_COMMENT}
-... @samp{#+END_COMMENT} will not be exported.
+and a whitespace are treated as comments and, as such, are not exported.
+
+Likewise, regions surrounded by @samp{#+BEGIN_COMMENT}
+... @samp{#+END_COMMENT} are not exported.
+
+Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any
+other keyword or priority cookie, comments out the entire subtree.  The
+command below helps changing the comment status of a headline.
 
 @table @kbd
 @item C-c ;