trim whitespace in the DoxygenTests when calling the MarkupFormatter #1329
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
Contributor
Author
|
@swift-ci Please test |
d-ronnqvist
reviewed
Oct 31, 2025
| XCTAssertEqual(symbol.abstract?.format(), "This is an abstract.") | ||
| XCTAssertEqual(symbol.discussion?.content.map { $0.format() }, [ | ||
| #"\abstract This is description with abstract."#, | ||
| #"\discussion This is a discussion linking to ``doc://unit-test/documentation/ModuleName/AnotherClass`` and ``doc://unit-test/documentation/ModuleName/AnotherClass/prop``."#, |
Contributor
There was a problem hiding this comment.
This assertions verify that 3 of the 4 symbol links in this text content resolves as expectedly.
Could we trim whitespace and newlines instead so that the test expectation is more flexible without losing the verification that the links are resolved in the markup?
Contributor
Author
There was a problem hiding this comment.
This sounds reasonable to me. I didn't know what the assertion was there for, but this makes sense. I've updated the commit to do this instead.
rdar://163704908
QuietMisdreavus
force-pushed
the
remove-format-assertions
branch
from
125d6be to
331633b
Compare
Contributor
Author
|
@swift-ci Please test |
QuietMisdreavus
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Bug/issue #, if applicable: rdar://163704908
Summary
When swiftlang/swift-markdown#237 was merged, a test in Swift-DocC started failing due to changes in the Swift-Markdown formatter. This PR updates the test assertion to trim whitespace and newlines, since the failure we saw was that an extra newline character was being inserted at the beginnings of lines.
Dependencies
None (The PR in Swift-Markdown was reverted, but the change here passes before and after the change is present.)
Testing
This is a test-only change. Ensure that all tests continue to pass, even after running
swift package update swift-markdown.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded