Skip to content

Commit 54e3a53

Browse files
committed
Update various documentation to avoid the "bundle" terminology
1 parent 766e3c5 commit 54e3a53

36 files changed

+172
-197
lines changed

Sources/SwiftDocC/Checker/Checkers/DuplicateTopicsSection.swift

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
This source file is part of the Swift.org open source project
33

4-
Copyright (c) 2021 Apple Inc. and the Swift project authors
4+
Copyright (c) 2021-2025 Apple Inc. and the Swift project authors
55
Licensed under Apache License v2.0 with Runtime Library Exception
66

77
See https://swift.org/LICENSE.txt for license information
@@ -11,9 +11,7 @@
1111
public import Foundation
1212
public import Markdown
1313

14-
/**
15-
A `Document` may only have one level-2 "Topics" heading at the top level, since it serves as structured data for a documentation bundle's hierarchy.
16-
*/
14+
/// A document only supports a single level-2 "Topics" heading at the top level, because it's used to define the documentation's hierarchy.
1715
public struct DuplicateTopicsSections: Checker {
1816
/// The list of level-2 headings with the text "Topics" found in the document.
1917
public var foundTopicsHeadings = [Heading]()

Sources/SwiftDocC/Converter/DocumentationContextConverter.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ public class DocumentationContextConverter {
4040
/// The remote source control repository where the documented module's source is hosted.
4141
let sourceRepository: SourceRepository?
4242

43-
/// Creates a new node converter for the given bundle and context.
43+
/// Creates a new node converter for the given context.
4444
///
45-
/// The converter uses bundle and context to resolve references to other documentation and describe the documentation hierarchy.
45+
/// The converter uses the context to resolve references to other documentation and describe the documentation hierarchy.
4646
///
4747
/// - Parameters:
4848
/// - context: The context that the converter uses to to resolve references it finds in the documentation node's content.

Sources/SwiftDocC/DocumentationService/Models/Services/Convert/ConvertRequest.swift

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ public import Foundation
1313

1414
/// A request to convert in-memory documentation.
1515
public struct ConvertRequest: Codable {
16-
/// Information about the documentation bundle to convert.
16+
/// Information about the documentation catalog to convert.
1717
///
1818
/// ## See Also
19-
/// - ``DocumentationBundle/Info``
2019
public var bundleInfo: DocumentationContext.Inputs.Info
20+
/// - ``DocumentationContext/Inputs/Info``
2121

2222
/// Feature flags to enable when performing this convert request.
2323
public var featureFlags: FeatureFlags
@@ -51,16 +51,16 @@ public struct ConvertRequest: Codable {
5151
/// Whether the conversion's render reference store should be included in the response.
5252
///
5353
/// The ``RenderReferenceStore`` contains compiled information for documentation nodes registered in a context. This
54-
/// information can be used as a lightweight index of the available documentation content in the bundle that's been converted.
54+
/// information can be used as a lightweight index of the available documentation content in the context that's been converted.
5555
public var includeRenderReferenceStore: Bool?
5656

57-
/// The file location of the bundle to convert, if any.
57+
/// The file location of the catalog to convert, if any.
5858
public var bundleLocation: URL?
5959

60-
/// The symbols graph data included in the documentation bundle to convert.
60+
/// The symbols graph data included in the documentation catalog to convert.
6161
///
6262
/// ## See Also
63-
/// - ``DocumentationBundle/symbolGraphURLs``
63+
/// - ``DocumentationContext/Inputs/symbolGraphURLs``
6464
public var symbolGraphs: [Data]
6565

6666
/// The mapping of external symbol identifiers to lines of a documentation comment that overrides the value in the symbol graph.
@@ -72,20 +72,20 @@ public struct ConvertRequest: Codable {
7272
/// Whether the conversion's rendered documentation should include source file location metadata.
7373
public var emitSymbolSourceFileURIs: Bool
7474

75-
/// The article and documentation extension file data included in the documentation bundle to convert.
75+
/// The article and documentation extension file data included in the documentation catalog to convert.
7676
///
7777
/// ## See Also
78-
/// - ``DocumentationBundle/markupURLs``
78+
/// - ``DocumentationContext/Inputs/markupURLs``
7979
public var markupFiles: [Data]
8080

8181

82-
/// The tutorial file data included in the documentation bundle to convert.
82+
/// The tutorial file data included in the documentation catalog to convert.
8383
public var tutorialFiles: [Data]
8484

85-
/// The on-disk resources in the documentation bundle to convert.
85+
/// The on-disk resources in the documentation catalog to convert.
8686
///
8787
/// ## See Also
88-
/// - ``DocumentationBundle/miscResourceURLs``
88+
/// - ``DocumentationContext/Inputs/miscResourceURLs``
8989
public var miscResourceURLs: [URL]
9090

9191
/// The symbol identifiers that have an expanded documentation page available if they meet the associated access level requirement.
@@ -97,22 +97,22 @@ public struct ConvertRequest: Codable {
9797

9898
/// Creates a request to convert in-memory documentation.
9999
/// - Parameters:
100-
/// - bundleInfo: Information about the bundle to convert.
100+
/// - bundleInfo: Information about the catalog to convert.
101101
/// - featureFlags: Feature flags to enable when performing this convert request.
102102
/// - externalIDsToConvert: The external IDs of the symbols to convert.
103103
/// - documentPathsToConvert: The paths of the documentation nodes to convert.
104104
/// - includeRenderReferenceStore: Whether the conversion's render reference store should be included in the
105105
/// response.
106-
/// - bundleLocation: The file location of the documentation bundle to convert, if any.
107-
/// - symbolGraphs: The symbols graph data included in the documentation bundle to convert.
106+
/// - bundleLocation: The file location of the documentation catalog to convert, if any.
107+
/// - symbolGraphs: The symbols graph data included in the documentation catalog to convert.
108108
/// - overridingDocumentationComments: The mapping of external symbol identifiers to lines of a
109109
/// documentation comment that overrides the value in the symbol graph.
110110
/// - emitSymbolSourceFileURIs: Whether the conversion's rendered documentation should include source file location metadata.
111111
/// - knownDisambiguatedSymbolPathComponents: The mapping of external symbol identifiers to
112112
/// known disambiguated symbol path components.
113-
/// - markupFiles: The article and documentation extension file data included in the documentation bundle to convert.
114-
/// - tutorialFiles: The tutorial file data included in the documentation bundle to convert.
115-
/// - miscResourceURLs: The on-disk resources in the documentation bundle to convert.
113+
/// - markupFiles: The article and documentation extension file data included in the documentation catalog to convert.
114+
/// - tutorialFiles: The tutorial file data included in the documentation catalog to convert.
115+
/// - miscResourceURLs: The on-disk resources in the documentation catalog to convert.
116116
/// - symbolIdentifiersWithExpandedDocumentation: A dictionary of identifiers to requirements for these symbols to have expanded
117117
/// documentation available.
118118
public init(

Sources/SwiftDocC/DocumentationService/Models/Services/Convert/ConvertResponse.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
This source file is part of the Swift.org open source project
33

4-
Copyright (c) 2021 Apple Inc. and the Swift project authors
4+
Copyright (c) 2021-2025 Apple Inc. and the Swift project authors
55
Licensed under Apache License v2.0 with Runtime Library Exception
66

77
See https://swift.org/LICENSE.txt for license information
@@ -18,10 +18,10 @@ public struct ConvertResponse: Codable {
1818
/// The render nodes that were created as part of the conversion, encoded as JSON.
1919
public var renderNodes: [Data]
2020

21-
/// The render reference store that was created as part of the bundle's conversion, encoded as JSON.
21+
/// The render reference store that was created as part of the documentation's conversion, encoded as JSON.
2222
///
2323
/// The ``RenderReferenceStore`` contains compiled information for documentation nodes that were registered as part of
24-
/// the conversion. This information can be used as a lightweight index of the available documentation content in the bundle that's
24+
/// the conversion. This information can be used as a lightweight index of the available documentation content in the context that's
2525
/// been converted.
2626
public var renderReferenceStore: Data?
2727

Sources/SwiftDocC/Indexing/Navigator/AvailabilityIndex+Ext.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
This source file is part of the Swift.org open source project
33

4-
Copyright (c) 2021-2024 Apple Inc. and the Swift project authors
4+
Copyright (c) 2021-2025 Apple Inc. and the Swift project authors
55
Licensed under Apache License v2.0 with Runtime Library Exception
66

77
See https://swift.org/LICENSE.txt for license information
@@ -63,7 +63,7 @@ extension AvailabilityIndex {
6363
// MARK: - InterfaceLanguage
6464

6565
/**
66-
Interface Language identifies a programming language used to index a content of a documentation bundle.
66+
Interface Language identifies a programming language used to index a content of a documentation context.
6767

6868
- Note: The name reflects what a render node JSON provides to identify a programming language.
6969
The name has been decided to avoid confusion with locale languages.

Sources/SwiftDocC/Indexing/Navigator/NavigatorIndex.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import Crypto
1414
/**
1515
A `NavigatorIndex` contains all the necessary information to display the data inside a navigator.
1616
The data ranges from the tree to the necessary pieces of information to filter the content and perform actions in a fast way.
17-
A navigator index is created per bundle and needs a bundle identifier to correctly work. Anonymous bundles are allowed, but they limit
17+
A navigator index is created per context and needs a bundle identifier to correctly work. Anonymous bundles are allowed, but they limit
1818
the functionalities of the index.
1919

2020
A `NavigatorIndex` is composed by two main components:

Sources/SwiftDocC/Infrastructure/Bundle Assets/BundleData.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
This source file is part of the Swift.org open source project
33

4-
Copyright (c) 2021 Apple Inc. and the Swift project authors
4+
Copyright (c) 2021-2025 Apple Inc. and the Swift project authors
55
Licensed under Apache License v2.0 with Runtime Library Exception
66

77
See https://swift.org/LICENSE.txt for license information
@@ -20,7 +20,7 @@ public struct BundleData {
2020

2121
/// Creates a bundle data value given its location and an associated trait collection.
2222
/// - Parameters:
23-
/// - url: The location of the resource in the documentation bundle.
23+
/// - url: The location of the resource in the documentation catalog.
2424
/// - traitCollection: An optional trait collection associated with the resource.
2525
public init(url: URL, traitCollection: DataTraitCollection?) {
2626
self.url = url

Sources/SwiftDocC/Infrastructure/Context/DocumentationContext+Configuration.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ extension DocumentationContext {
3636
/// path components into the documentation context.
3737
var knownDisambiguatedSymbolPathComponents: [String: [String]]?
3838

39-
/// Controls whether bundle registration should allow registering articles when no technology root is defined.
39+
/// Controls whether catalog registration should allow registering articles when no technology root is defined.
4040
///
4141
/// Set this property to `true` to enable registering documentation for standalone articles,
4242
/// for example when using ``ConvertService``.

Sources/SwiftDocC/Infrastructure/ConvertActionConverter.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ package enum ConvertActionConverter {
2121
static package let signposter = NoOpSignposterShim()
2222
#endif
2323

24-
/// Converts the documentation bundle in the given context and passes its output to a given consumer.
24+
/// Converts the documentation catalog in the given context and passes its output to a given consumer.
2525
///
2626
/// - Parameters:
2727
/// - context: The context of documentation information to convert.
@@ -105,7 +105,7 @@ package enum ConvertActionConverter {
105105

106106
// Consume external links and add them into the sidebar.
107107
for externalLink in context.externalCache {
108-
// Here we're associating the external node with the **current** bundle's bundle ID.
108+
// Here we're associating the external node with the **current** local bundle ID.
109109
// This is needed because nodes are only considered children if the parent and child's bundle ID match.
110110
// Otherwise, the node will be considered as a separate root node and displayed separately.
111111
let externalRenderNode = ExternalRenderNode(externalEntity: externalLink.value, bundleIdentifier: id)

0 commit comments

Comments
 (0)