Block Comments
++++++++++++++
.. this is a comment
..
also, this is
a multiline comment.
Neither comment will appear in rendered output.
reST only has a `block level comment mechanism
<http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
#comments>`
To create an inline comment, CS: this is something that can be necessary for a variety of reasons use the :flag3: role, an ICG customization.
It is also good form, though not strictly necessary, to put your initials in the comment so that later authors/editors can backtrack to the original comment author as needed.
To create an inline comment, :flag3:`CS: this is something that can be
necessary for a variety of reasons` use the ``:flag3:`` role, an ICG
customization.
What’s Up with ;; and ;;;?
Block comments in the ICG docs may include ;; and/or ;;; within them. These are not necessary parts of the markup, they are usage conventions to allow comments to be picked up by syntax highlighters.
9.4.35
Comments
Block Comments
reST only has a block level comment mechanism.
Inline Comments
Please Don’t
Please don’t use the
:flag:role at any time.To create an inline comment, CS: this is something that can be necessary for a variety of reasons use the
:flag3:role, an ICG customization.It is also good form, though not strictly necessary, to put your initials in the comment so that later authors/editors can backtrack to the original comment author as needed.
What’s Up with
;;and;;;?Block comments in the ICG docs may include
;;and/or;;;within them. These are not necessary parts of the markup, they are usage conventions to allow comments to be picked up by syntax highlighters.