Skip to content

trim whitespace in the DoxygenTests when calling the MarkupFormatter #1329

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.

Sign up for GitHub

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

Merged
QuietMisdreavus merged 1 commit into from
Nov 3, 2025
Merged

trim whitespace in the DoxygenTests when calling the MarkupFormatter #1329

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Tests/SwiftDocCTests/Semantics/DoxygenTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ class DoxygenTests: XCTestCase {
let symbol = try XCTUnwrap(node.semantic as? Symbol)

XCTAssertEqual(symbol.abstract?.format(), "This is an abstract.")
XCTAssertEqual(symbol.discussion?.content.map { $0.format() }, [
XCTAssertEqual(symbol.discussion?.content.map { $0.format().trimmingCharacters(in: .whitespacesAndNewlines) }, [
#"\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``."#,
Copy link
Contributor

@d-ronnqvist d-ronnqvist Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor Author

@QuietMisdreavus QuietMisdreavus Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

#"\note This is a note linking to ``doc://unit-test/documentation/ModuleName/Class3`` and ``Class3/prop2``."#
Expand Down