Fix invalid HTML comments #334
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
amartini51
force-pushed
the
html_comments
branch
from
17b204b to
1d0e452
Compare
|
Reviewed with & approved by Robert Olsen offline. Made a note to check for any other |
amartini51
added a commit
to amartini51/swift-book
that referenced
this pull request
Jan 28, 2025
Re-applied the changes from commit 1b663f7 (Fix invalid HTML comments (swiftlang#334), 2024-12-04) -- which landed on 'main' after this branch diverged -- to the new location for that content. Reviewed this branch's changes, before and after this merge, as follows: opendiff =(git diff main...b6439e7) =(git diff main...HEAD) References: 1b663f7 References: b6439e7
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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