Add an Span (Inline) Comment Token? about myst-parser HOT 3 OPEN

No problem, I've added the documentation now in #117. Take a look at https://272-240151150-gh.circle-artifacts.com/0/html/using/syntax.html#comments

from myst-parser.

So, this is the actual docutils AST rendered:

line 1
% a comment
line 2

<document source="notset">
    <paragraph>
        line 1
    <comment xml:space="preserve">
        a comment
    <paragraph>
        line 2

This is the 'correct' behaviour, given the fact that (as it stands) a LineComment is defined as a block level entity,
such that when one is found the current block element is terminated (in this case a paragraph).

What you are after here is a span level (a.k.a inline) comment entity, whereby the comment is parsed as:

<document source="notset">
    <paragraph>
        line 1
        <comment xml:space="preserve">
            a comment
        line 2

This essentially would require an additional syntax element to be implemented, which would be fairly tricky, so I can't promise I could achieve this any time soon.

Perhaps at a minimum the documentation should make this clear.

from myst-parser.

Got it, thanks for clarification. It's not fair to blame this on the documentation necessarily - I had barreled ahead without realizing the distinction between the line comment and inline comments 😑 . That said, I will take a closer look to see if an extra example in the docs wouldn't hurt.

from myst-parser.