Skip to content

Commit 9b8db28

Browse files
d-ronnqvistd-ronnqvist
authored
Remove throws for function that doesn't raise any errors. (#1109)
1 parent ff4ba14 commit 9b8db28

16 files changed

+53
-53
lines changed

‎Sources/SwiftDocC/Converter/DocumentationNodeConverter.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ public struct DocumentationNodeConverter {
3636
/// - Parameters:
3737
/// - node: The documentation node to convert.
3838
/// - Returns: The render node representation of the documentation node.
39-
public func convert(_ node: DocumentationNode) throws -> RenderNode {
39+
public func convert(_ node: DocumentationNode) -> RenderNode {
4040
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference)
4141
return translator.visit(node.semantic) as! RenderNode
4242
}
4343

4444
@available(*, deprecated, renamed: "convert(_:)", message: "Use 'convert(_:)' instead. This deprecated API will be removed after 6.1 is released")
4545
public func convert(_ node: DocumentationNode, at source: URL?) throws -> RenderNode {
46-
return try convert(node)
46+
return convert(node)
4747
}
4848
}

‎Tests/SwiftDocCTests/Converter/DocumentationContextConverterTests.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ class DocumentationContextConverterTests: XCTestCase {
2727
for identifier in context.knownPages {
2828
let documentationNode = try XCTUnwrap(try context.entity(with: identifier))
2929

30-
let renderNode1 = try perNodeConverter.convert(documentationNode)
30+
let renderNode1 = perNodeConverter.convert(documentationNode)
3131
let renderNode2 = bulkNodeConverter.renderNode(for: documentationNode)
3232

3333
// Compare the two nodes are identical

‎Tests/SwiftDocCTests/Converter/TopicRenderReferenceEncoderTests.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ class TopicRenderReferenceEncoderTests: XCTestCase {
170170
// For reach topic encode its render node and verify the references are in alphabetical order.
171171
for reference in context.knownPages {
172172
let node = try context.entity(with: reference)
173-
let renderNode = try converter.convert(node)
173+
let renderNode = converter.convert(node)
174174

175175
// Get the encoded JSON as string
176176
let encodedData = try renderNode.encodeToJSON(with: encoder, renderReferenceCache: cache)
@@ -228,7 +228,7 @@ class TopicRenderReferenceEncoderTests: XCTestCase {
228228
// For reach topic encode its render node and verify the references are in alphabetical order.
229229
for reference in context.knownPages {
230230
let node = try context.entity(with: reference)
231-
let renderNode = try converter.convert(node)
231+
let renderNode = converter.convert(node)
232232

233233
// Get the encoded JSON as string
234234
let encodedData = try renderNode.encodeToJSON(with: encoder)

‎Tests/SwiftDocCTests/Indexing/NavigatorIndexTests.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -957,7 +957,7 @@ Root
957957

958958
for identifier in context.knownPages {
959959
let entity = try context.entity(with: identifier)
960-
let renderNode = try converter.convert(entity)
960+
let renderNode = converter.convert(entity)
961961
try builder.index(renderNode: renderNode)
962962
}
963963

@@ -1673,7 +1673,7 @@ Root
16731673

16741674
for identifier in context.knownPages {
16751675
let entity = try context.entity(with: identifier)
1676-
let renderNode = try converter.convert(entity)
1676+
let renderNode = converter.convert(entity)
16771677
try builder.index(renderNode: renderNode)
16781678
}
16791679

‎Tests/SwiftDocCTests/Infrastructure/AnchorSectionTests.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ class AnchorSectionTests: XCTestCase {
6767

6868
// Verify collecting section render references
6969
let converter = DocumentationNodeConverter(bundle: bundle, context: context)
70-
let renderNode = try converter.convert(entity)
70+
let renderNode = converter.convert(entity)
7171

7272
let sectionReference = try XCTUnwrap(renderNode.references["doc://org.swift.docc.example/documentation/TechnologyX/Article#Article-Sub-Section"] as? TopicRenderReference)
7373
XCTAssertEqual(sectionReference.title, "Article Sub-Section")
@@ -125,7 +125,7 @@ class AnchorSectionTests: XCTestCase {
125125

126126
// Verify collecting section render references
127127
let converter = DocumentationNodeConverter(bundle: bundle, context: context)
128-
let renderNode = try converter.convert(entity)
128+
let renderNode = converter.convert(entity)
129129

130130
let sectionReference = try XCTUnwrap(renderNode.references["doc://org.swift.docc.example/documentation/CoolFramework/CoolClass#Symbol-Sub-Section"] as? TopicRenderReference)
131131
XCTAssertEqual(sectionReference.title, "Symbol Sub-Section")
@@ -183,7 +183,7 @@ class AnchorSectionTests: XCTestCase {
183183

184184
// Verify collecting section render references
185185
let converter = DocumentationNodeConverter(bundle: bundle, context: context)
186-
let renderNode = try converter.convert(entity)
186+
let renderNode = converter.convert(entity)
187187

188188
let sectionReference = try XCTUnwrap(renderNode.references["doc://org.swift.docc.example/documentation/CoolFramework#Module-Sub-Section"] as? TopicRenderReference)
189189
XCTAssertEqual(sectionReference.title, "Module Sub-Section")

‎Tests/SwiftDocCTests/Infrastructure/DocumentationContext/DocumentationContextTests.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3237,7 +3237,7 @@ let expected = """
32373237
// Verify that the links are resolved in the render model.
32383238
let bundle = try XCTUnwrap(context.bundle)
32393239
let converter = DocumentationNodeConverter(bundle: bundle, context: context)
3240-
let renderNode = try converter.convert(entity)
3240+
let renderNode = converter.convert(entity)
32413241

32423242
XCTAssertEqual(renderNode.topicSections.map(\.anchor), [
32433243
"Another-topic-section"
@@ -5327,7 +5327,7 @@ let expected = """
53275327
let node = try context.entity(with: reference)
53285328

53295329
let converter = DocumentationNodeConverter(bundle: bundle, context: context)
5330-
let renderNode = try converter.convert(node)
5330+
let renderNode = converter.convert(node)
53315331

53325332
let externalReference = "doc://Dependency/documentation/ExternalModuleName"
53335333

‎Tests/SwiftDocCTests/Infrastructure/DocumentationCuratorTests.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -490,7 +490,7 @@ class DocumentationCuratorTests: XCTestCase {
490490
XCTAssertEqual("doc://com.test.TestBed/documentation/TestBed/MyArticle", symbol.topics?.taskGroups.first?.links.first?.destination)
491491

492492
let converter = DocumentationNodeConverter(bundle: bundle, context: context)
493-
let renderNode = try converter.convert(entity)
493+
let renderNode = converter.convert(entity)
494494

495495
// Verify the article identifier is included in the task group for the render node.
496496
XCTAssertEqual("doc://com.test.TestBed/documentation/TestBed/MyArticle", renderNode.topicSections.first?.identifiers.first)

‎Tests/SwiftDocCTests/Infrastructure/ExternalPathHierarchyResolverTests.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1003,7 +1003,7 @@ class ExternalPathHierarchyResolverTests: XCTestCase {
10031003
let converter = DocumentationNodeConverter(bundle: bundle, context: context)
10041004
for reference in context.knownPages {
10051005
let node = try context.entity(with: reference)
1006-
let renderNode = try converter.convert(node)
1006+
let renderNode = converter.convert(node)
10071007
entitySummaries.append(contentsOf: node.externallyLinkableElementSummaries(context: context, renderNode: renderNode, includeTaskGroups: false))
10081008
}
10091009

‎Tests/SwiftDocCTests/Infrastructure/ExternalReferenceResolverTests.swift

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ class ExternalReferenceResolverTests: XCTestCase {
125125
sourceLanguage: .swift
126126
)
127127
let node = try context.entity(with: sideClassReference)
128-
let renderNode = try converter.convert(node)
128+
let renderNode = converter.convert(node)
129129

130130
// First assert that the external reference is included in the render node's references
131131
// and is defined as expected.
@@ -267,7 +267,7 @@ class ExternalReferenceResolverTests: XCTestCase {
267267
"The test content should include a link for the external reference resolver to resolve"
268268
)
269269

270-
let renderNode = try converter.convert(node)
270+
let renderNode = converter.convert(node)
271271

272272
guard let symbolRenderReference = renderNode.references[expectedReference] as? TopicRenderReference else {
273273
XCTFail("The external reference should be resolved and included among the Tutorial's references.")
@@ -310,7 +310,7 @@ class ExternalReferenceResolverTests: XCTestCase {
310310
let converter = DocumentationNodeConverter(bundle: bundle, context: context)
311311
let node = try context.entity(with: ResolvedTopicReference(bundleID: bundle.id, path: "/documentation/SideKit/SideClass", sourceLanguage: .swift))
312312

313-
let renderNode = try converter.convert(node)
313+
let renderNode = converter.convert(node)
314314

315315
guard let symbolRenderReference = renderNode.references["doc://com.test.external/path/to/external/symbol"] as? TopicRenderReference else {
316316
XCTFail("The external reference should be resolved and included among the SideClass symbols's references.")
@@ -355,7 +355,7 @@ class ExternalReferenceResolverTests: XCTestCase {
355355
let converter = DocumentationNodeConverter(bundle: bundle, context: context)
356356
let node = try context.entity(with: ResolvedTopicReference(bundleID: bundle.id, path: "/documentation/article", sourceLanguage: .swift))
357357

358-
let renderNode = try converter.convert(node)
358+
let renderNode = converter.convert(node)
359359

360360
XCTAssertEqual(externalResolver.resolvedExternalPaths, ["/path/to/external/symbol"], "The authored link was resolved")
361361

@@ -402,7 +402,7 @@ class ExternalReferenceResolverTests: XCTestCase {
402402
let converter = DocumentationNodeConverter(bundle: bundle, context: context)
403403
let node = try context.entity(with: ResolvedTopicReference(bundleID: bundle.id, path: "/documentation/SideKit/SideClass", sourceLanguage: .swift))
404404

405-
let renderNode = try converter.convert(node)
405+
let renderNode = converter.convert(node)
406406

407407
guard let sampleRenderReference = renderNode.references["doc://com.test.external/path/to/external/sample"] as? TopicRenderReference else {
408408
XCTFail("The external reference should be resolved and included among the SideClass symbols's references.")
@@ -501,7 +501,7 @@ class ExternalReferenceResolverTests: XCTestCase {
501501
let converter = DocumentationNodeConverter(bundle: bundle, context: context)
502502
let node = try context.entity(with: ResolvedTopicReference(bundleID: bundle.id, path: "/documentation/SomeSample", sourceLanguage: .swift))
503503

504-
let renderNode = try converter.convert(node)
504+
let renderNode = converter.convert(node)
505505

506506
XCTAssertEqual(context.assetManagers.keys.sorted(), ["org.swift.docc.sample"],
507507
"The external bundle for the external asset shouldn't have it's own asset manager")
@@ -770,7 +770,7 @@ class ExternalReferenceResolverTests: XCTestCase {
770770
// Get MyKit symbol
771771
let entity = try context.entity(with: .init(bundleID: bundle.id, path: "/documentation/MyKit", sourceLanguage: .swift))
772772
let converter = DocumentationNodeConverter(bundle: bundle, context: context)
773-
let renderNode = try converter.convert(entity)
773+
let renderNode = converter.convert(entity)
774774

775775
let taskGroupLinks = try XCTUnwrap(renderNode.seeAlsoSections.first?.identifiers)
776776
// Verify the unresolved links are not included in the task group.
@@ -896,7 +896,7 @@ class ExternalReferenceResolverTests: XCTestCase {
896896
sourceLanguage: .swift
897897
)
898898
let node = try context.entity(with: mixedLanguageFrameworkReference)
899-
let renderNode = try converter.convert(node)
899+
let renderNode = converter.convert(node)
900900
// Topic identifiers in the Swift variant of the `MixedLanguageFramework` symbol
901901
let swiftTopicIDs = renderNode.topicSections.flatMap(\.identifiers)
902902

@@ -1039,7 +1039,7 @@ class ExternalReferenceResolverTests: XCTestCase {
10391039
do {
10401040
let reference = ResolvedTopicReference(bundleID: bundle.id, path: "/documentation/unit-test/First", sourceLanguage: .swift)
10411041
let node = try context.entity(with: reference)
1042-
let rendered = try converter.convert(node)
1042+
let rendered = converter.convert(node)
10431043

10441044
XCTAssertEqual(rendered.seeAlsoSections.count, 1, "The page should only have the automatic See Also section created based on the curation on the Root page.")
10451045
let seeAlso = try XCTUnwrap(rendered.seeAlsoSections.first)
@@ -1053,7 +1053,7 @@ class ExternalReferenceResolverTests: XCTestCase {
10531053
do {
10541054
let reference = ResolvedTopicReference(bundleID: bundle.id, path: "/documentation/unit-test/Second", sourceLanguage: .swift)
10551055
let node = try context.entity(with: reference)
1056-
let rendered = try converter.convert(node)
1056+
let rendered = converter.convert(node)
10571057

10581058
XCTAssertEqual(rendered.seeAlsoSections.count, 1, "The page should only have the automatic See Also section created based on the curation on the Root page.")
10591059
let seeAlso = try XCTUnwrap(rendered.seeAlsoSections.first)
@@ -1094,7 +1094,7 @@ class ExternalReferenceResolverTests: XCTestCase {
10941094
let reference = try XCTUnwrap(context.soleRootModuleReference)
10951095
let node = try context.entity(with: reference)
10961096
let converter = DocumentationNodeConverter(bundle: bundle, context: context)
1097-
let rendered = try converter.convert(node)
1097+
let rendered = converter.convert(node)
10981098

10991099
XCTAssertEqual(rendered.seeAlsoSections.count, 1, "The page should only have the authored See Also section.")
11001100
let seeAlso = try XCTUnwrap(rendered.seeAlsoSections.first)

‎Tests/SwiftDocCTests/LinkTargets/LinkDestinationSummaryTests.swift

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ class ExternalLinkableTests: XCTestCase {
9999
let converter = DocumentationNodeConverter(bundle: bundle, context: context)
100100

101101
let node = try context.entity(with: ResolvedTopicReference(bundleID: bundle.id, path: "/tutorials/TestBundle/Tutorial", sourceLanguage: .swift))
102-
let renderNode = try converter.convert(node)
102+
let renderNode = converter.convert(node)
103103

104104
let summaries = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)
105105
let pageSummary = summaries[0]
@@ -156,7 +156,7 @@ class ExternalLinkableTests: XCTestCase {
156156
do {
157157
let symbolReference = ResolvedTopicReference(bundleID: "org.swift.docc.example", path: "/documentation/MyKit/MyClass", sourceLanguage: .swift)
158158
let node = try context.entity(with: symbolReference)
159-
let renderNode = try converter.convert(node)
159+
let renderNode = converter.convert(node)
160160
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]
161161

162162
XCTAssertEqual(summary.title, "MyClass")
@@ -200,7 +200,7 @@ class ExternalLinkableTests: XCTestCase {
200200
do {
201201
let symbolReference = ResolvedTopicReference(bundleID: "org.swift.docc.example", path: "/documentation/MyKit/MyProtocol", sourceLanguage: .swift)
202202
let node = try context.entity(with: symbolReference)
203-
let renderNode = try converter.convert(node)
203+
let renderNode = converter.convert(node)
204204
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]
205205

206206
XCTAssertEqual(summary.title, "MyProtocol")
@@ -241,7 +241,7 @@ class ExternalLinkableTests: XCTestCase {
241241
do {
242242
let symbolReference = ResolvedTopicReference(bundleID: "org.swift.docc.example", path: "/documentation/MyKit/MyClass/myFunction()", sourceLanguage: .swift)
243243
let node = try context.entity(with: symbolReference)
244-
let renderNode = try converter.convert(node)
244+
let renderNode = converter.convert(node)
245245
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]
246246

247247
XCTAssertEqual(summary.title, "myFunction()")
@@ -276,7 +276,7 @@ class ExternalLinkableTests: XCTestCase {
276276
do {
277277
let symbolReference = ResolvedTopicReference(bundleID: "org.swift.docc.example", path: "/documentation/MyKit/globalFunction(_:considering:)", sourceLanguage: .swift)
278278
let node = try context.entity(with: symbolReference)
279-
let renderNode = try converter.convert(node)
279+
let renderNode = converter.convert(node)
280280
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]
281281

282282
XCTAssertEqual(summary.title, "globalFunction(_:considering:)")
@@ -333,7 +333,7 @@ class ExternalLinkableTests: XCTestCase {
333333
do {
334334
let symbolReference = ResolvedTopicReference(bundleID: "org.swift.docc.example", path: "/documentation/MyKit/MyClass/myFunction()", sourceLanguage: .swift)
335335
let node = try context.entity(with: symbolReference)
336-
let renderNode = try converter.convert(node)
336+
let renderNode = converter.convert(node)
337337
var summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]
338338

339339
XCTAssertEqual(summary.title, "myFunction()")
@@ -438,7 +438,7 @@ class ExternalLinkableTests: XCTestCase {
438438
do {
439439
let symbolReference = ResolvedTopicReference(bundleID: "org.swift.MixedLanguageFramework", path: "/documentation/MixedLanguageFramework/Bar", sourceLanguage: .swift)
440440
let node = try context.entity(with: symbolReference)
441-
let renderNode = try converter.convert(node)
441+
let renderNode = converter.convert(node)
442442
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]
443443

444444
XCTAssertEqual(summary.title, "Bar")
@@ -497,7 +497,7 @@ class ExternalLinkableTests: XCTestCase {
497497
do {
498498
let symbolReference = ResolvedTopicReference(bundleID: "org.swift.MixedLanguageFramework", path: "/documentation/MixedLanguageFramework/Bar/myStringFunction(_:)", sourceLanguage: .swift)
499499
let node = try context.entity(with: symbolReference)
500-
let renderNode = try converter.convert(node)
500+
let renderNode = converter.convert(node)
501501
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]
502502

503503
XCTAssertEqual(summary.title, "myStringFunction(_:)")
@@ -728,7 +728,7 @@ class ExternalLinkableTests: XCTestCase {
728728
let converter = DocumentationNodeConverter(bundle: bundle, context: context)
729729

730730
let node = try context.entity(with: ResolvedTopicReference(bundleID: bundle.id, path: "/documentation/MyModule/MyClass/myFunc()", sourceLanguage: .swift))
731-
let renderNode = try converter.convert(node)
731+
let renderNode = converter.convert(node)
732732

733733
let summaries = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)
734734
let pageSummary = summaries[0]

0 commit comments

Comments
 (0)