Skip to content

Commit 427e27c

Browse files
committed
Rename helper function for readability
Clarifies the function name so that it clearly states that only top level nodes are returned, as well as improving the grammar at the call site.
1 parent 56672da commit 427e27c

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Tests/SwiftDocCTests/Indexing/ExternalRenderNodeTests.swift

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -269,15 +269,15 @@ class ExternalRenderNodeTests: XCTestCase {
269269
XCTAssertEqual(renderIndex.interfaceLanguages[SourceLanguage.objectiveC.id]?.count(where: \.isExternal), 0)
270270

271271

272-
func externalNodes(by language: SourceLanguage) -> [RenderIndex.Node]? {
272+
func externalTopLevelNodes(for language: SourceLanguage) -> [RenderIndex.Node]? {
273273
renderIndex.interfaceLanguages[language.id]?.first?.children?.filter(\.isExternal)
274274
}
275275

276276
// Verify that the curated external links are part of the index.
277-
let swiftExternalNodes = try XCTUnwrap(externalNodes(by: .swift))
277+
let swiftExternalNodes = try XCTUnwrap(externalTopLevelNodes(for: .swift))
278278
XCTAssertEqual(swiftExternalNodes.count, 2)
279279

280-
let objcExternalNodes = try XCTUnwrap(externalNodes(by: .objectiveC))
280+
let objcExternalNodes = try XCTUnwrap(externalTopLevelNodes(for: .objectiveC))
281281
XCTAssertEqual(objcExternalNodes.count, 2)
282282

283283
let swiftArticleExternalNode = try XCTUnwrap(swiftExternalNodes.first(where: { $0.path == "/path/to/external/swiftarticle" }))
@@ -358,13 +358,13 @@ class ExternalRenderNodeTests: XCTestCase {
358358
XCTAssertEqual(renderIndex.interfaceLanguages[SourceLanguage.swift.id]?.count(where: \.isExternal), 0)
359359
XCTAssertEqual(renderIndex.interfaceLanguages[SourceLanguage.objectiveC.id]?.count(where: \.isExternal), 0)
360360

361-
func externalNodes(by language: SourceLanguage) -> [RenderIndex.Node]? {
361+
func externalTopLevelNodes(for language: SourceLanguage) -> [RenderIndex.Node]? {
362362
renderIndex.interfaceLanguages[language.id]?.first?.children?.filter(\.isExternal)
363363
}
364364

365365
// Verify that the curated external links are part of the index.
366-
let swiftExternalNodes = try XCTUnwrap(externalNodes(by: .swift))
367-
let objcExternalNodes = try XCTUnwrap(externalNodes(by: .objectiveC))
366+
let swiftExternalNodes = try XCTUnwrap(externalTopLevelNodes(for: .swift))
367+
let objcExternalNodes = try XCTUnwrap(externalTopLevelNodes(for: .objectiveC))
368368

369369
XCTAssertEqual(swiftExternalNodes.count, 1)
370370
XCTAssertEqual(objcExternalNodes.count, 1)

0 commit comments

Comments
 (0)