Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix invalid HTML comments #334

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

amartini51
Copy link
Member

The line "---" indicated to the pre-DocC build system's code testing infrastructure that the code listing contains a blank line at that point. However, two hyphens in a row is invalid inside of an HTML style comment.

Fixes: rdar://136551557

The line "---" indicated to the pre-DocC build system's code testing
infrastructure that the code listing contains a blank line at that
point.  However, two hyphens in a row is invalid inside of an HTML
<!-- --> style comment.

Changed to blank lines because that was another way to spell the same
thing in the old test system (although it might have been fragile, and
was less used), but more importantly we're unlikely to use the old test
system again.  These test expectation lines were preserved during the
export to assist writing new expectation markup in some future testing
system.

Bulk edit via:

    sed -i .bak -e 's/^ *--- *$//' TSPL.docc/*/*.md

Confirmed no change to the Render JSON from DocC.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant