Don't put "-* no-capture-flag *-" on its own line #3702
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Otherwise, the documentation will be garbled.
When not-capturing an example, we remove any instances of the string
"-* no-capture-flag *-"
. If this string is by itself on a line, then we end up with an empty line in the example input, which messes everything up.One example is the findProgram docs. This is out of order:
After the change:
It might be more elegant to also remove the newline in the special case where
-* no-capture-flag *-
is by itself on a line. Allowing-- no-capture-flag
would be cool too. But that would require some fancier regexes. But right now, this only affects Macaulay2Doc. Maybe something to think about if/when we start capturing the other packages' examples.