Commit dec56936 authored by Craig Scott's avatar Craig Scott Committed by Kitware Robot

Merge topic 'bracket-comment-doc-clarification'

12456450 Help: Clarify that bracket comments start with bracket open
Acked-by: Kitware Robot's avatarKitware Robot <kwrobot@kitware.com>
Acked-by: Brad King's avatarBrad King <brad.king@kitware.com>
Acked-by: Ben McMorran's avatarBen McMorran <ben.mcmorran@gmail.com>
Merge-request: !3331
parents 3bd8ed22 12456450
Pipeline #137299 failed with stage
in 0 seconds
......@@ -430,7 +430,7 @@ comments: a `Bracket Comment`_ and a `Line Comment`_.
Bracket Comment
^^^^^^^^^^^^^^^
A ``#`` immediately followed by a `Bracket Argument`_ forms a
A ``#`` immediately followed by a :token:`bracket_open` forms a
*bracket comment* consisting of the entire bracket enclosure:
.. raw:: latex
......@@ -461,7 +461,7 @@ For example:
Line Comment
^^^^^^^^^^^^
A ``#`` not immediately followed by a `Bracket Argument`_ forms a
A ``#`` not immediately followed by a :token:`bracket_open` forms a
*line comment* that runs until the end of the line:
.. raw:: latex
......@@ -469,7 +469,7 @@ A ``#`` not immediately followed by a `Bracket Argument`_ forms a
\begin{small}
.. productionlist::
line_comment: '#' <any text not starting in a `bracket_argument`
line_comment: '#' <any text not starting in a `bracket_open`
: and not containing a `newline`>
.. raw:: latex
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment