fix typos

theMomax · theMomax · commit 03af8e2afb26 · 2022-09-07T15:24:44.000+02:00
diff --git a/Sources/SwiftDocC/Infrastructure/Symbol Graph/ExtendedTypesFormatTransformation.swift b/Sources/SwiftDocC/Infrastructure/Symbol Graph/ExtendedTypesFormatTransformation.swift
@@ -54,10 +54,10 @@ extension ExtendedTypesFormatTransformation {
     ///
     /// The extended type symbol format provides a more concise and hierarchical structure:
     /// - a member symbol of the according kind for all added members
-    /// - an **extended type symbol** _for each external type that was extended_ (and its anchestors, if the extended
+    /// - an **extended type symbol** _for each external type that was extended_ (and its ancestors, if the extended
     ///   type is a nested type):
     ///     - ``SymbolKit/SymbolGraph/Symbol/KindIdentifier/extendedStruct``
-    ///     - ``SymbolKit/SymbolGraph/Symbol/KindIdentifier/extemdedClass``
+    ///     - ``SymbolKit/SymbolGraph/Symbol/KindIdentifier/extendedClass``
     ///     - ``SymbolKit/SymbolGraph/Symbol/KindIdentifier/extendedEnum``
     ///     - ``SymbolKit/SymbolGraph/Symbol/KindIdentifier/extendedProtocol``
     ///     - ``SymbolKit/SymbolGraph/Symbol/KindIdentifier/unknownExtendedType``
@@ -83,7 +83,7 @@ extension ExtendedTypesFormatTransformation {
     /// └────────────┘ 0..1                n└─────────────┘ 1                n └────────────────┘
     /// ```
     ///
-    /// - Parameter symbolGraph: An (extension) symbol graph that should use the extensoin block symbol format.
+    /// - Parameter symbolGraph: An (extension) symbol graph that should use the extension block symbol format.
     /// - Parameter moduleName: The name of the extended module all top-level symbols in this symbol graph belong to.
     /// - Returns: Returns whether the transformation was applied (the `symbolGraph` was an extension graph
     /// in the extended type symbol format) or not
@@ -117,7 +117,7 @@ extension ExtendedTypesFormatTransformation {
             }
             
             // we sort the symbols here because their order is not guaranteed to stay the same
-            // accross compilation processes and we always want to choose the same doc comment
+            // across compilation processes and we always want to choose the same doc comment
             // in case there are multiple candidates with maximum number of lines
             if let winner = relevantExtensionBlockSymbols.sorted(by: \.identifier.precise).max(by: { a, b in (a.docComment?.lines.count ?? 0) < (b.docComment?.lines.count ?? 0) }) {
                 return [winner]
@@ -138,7 +138,7 @@ extension ExtendedTypesFormatTransformation {
         return true
     }
 
-    /// Tries to obtain `docComment`s for all `targets` and copies the documentaiton from sources to the target.
+    /// Tries to obtain `docComment`s for all `targets` and copies the documentation from sources to the target.
     ///
     /// Iterates over all `targets` calling the `source` method to obtain a list of symbols that should serve as sources for the target's `docComment`.
     /// If there is more than one symbol containing a `docComment` in the compound list of target and the list returned by `source`, `onConflict` is
@@ -196,9 +196,9 @@ extension ExtendedTypesFormatTransformation {
 
     /// Collects all relationships that touch any of the given extension symbols, removes them from the `symbolGraph`, and returns them separately.
     ///
-    /// The relevant relationships in this context are of the follwing kinds:
+    /// The relevant relationships in this context are of the following kinds:
     ///
-    /// - `.extenisonTo`: the `source` must be of kind `.extension`
+    /// - `.extensionTo`: the `source` must be of kind `.extension`
     /// - `.conformsTo`: the `source` may be of kind `.extension`
     /// - `.memberOf`: the `target` may be of kind `.extension`
     ///
@@ -241,11 +241,11 @@ extension ExtendedTypesFormatTransformation {
         return (extensionToRelationships, memberOfRelationships, conformsToRelationships)
     }
 
-    /// Synthesizes extended type symbols from the given `extensionBlockSymbols` and `extensoinToRelationships`.
+    /// Synthesizes extended type symbols from the given `extensionBlockSymbols` and `extensionToRelationships`.
     ///
     /// Creates symbols of the following kinds:
     /// - ``SymbolKit/SymbolGraph/Symbol/KindIdentifier/extendedStruct``
-    /// - ``SymbolKit/SymbolGraph/Symbol/KindIdentifier/extemdedClass``
+    /// - ``SymbolKit/SymbolGraph/Symbol/KindIdentifier/extendedClass``
     /// - ``SymbolKit/SymbolGraph/Symbol/KindIdentifier/extendedEnum``
     /// - ``SymbolKit/SymbolGraph/Symbol/KindIdentifier/extendedProtocol``
     ///
@@ -279,12 +279,12 @@ extension ExtendedTypesFormatTransformation {
             if let declarationFragments = extensionBlockSymbol[mixin: SymbolGraph.Symbol.DeclarationFragments.self]?.declarationFragments {
                 var prefixWithoutWhereClause: [SymbolGraph.Symbol.DeclarationFragments.Fragment] = Array(declarationFragments[..<3])
                 
-            outer: for fragement in declarationFragments[3...] {
-                    switch (fragement.kind, fragement.spelling) {
+            outer: for fragment in declarationFragments[3...] {
+                    switch (fragment.kind, fragment.spelling) {
                     case (.typeIdentifier, _),
                          (.identifier, _),
                          (.text, "."):
-                        prefixWithoutWhereClause.append(fragement)
+                        prefixWithoutWhereClause.append(fragment)
                     default:
                         break outer
                     }
@@ -307,7 +307,7 @@ extension ExtendedTypesFormatTransformation {
         var extendedTypeSymbolIdentifiers: [String: String] = [:]
         
         // we sort the relationships here because their order is not guaranteed to stay the same
-        // accross compilation processes and choosing the same base symbol (and its USR) is important
+        // across compilation processes and choosing the same base symbol (and its USR) is important
         // to keeping (colliding) links stable
         for extensionTo in extensionToRelationships.sorted(by: \.source) {
             guard let extensionBlockSymbol = extensionBlockSymbols[extensionTo.source] else {
@@ -332,15 +332,15 @@ extension ExtendedTypesFormatTransformation {
         return (extendedTypeSymbols, extensionBlockToExtendedTypeMapping, extendedTypeToExtensionBlockMapping)
     }
     
-    /// Synthesizes missing anchestor extended type symbols for any nested types among the `extendedTypeSymbols` and
+    /// Synthesizes missing ancestor extended type symbols for any nested types among the `extendedTypeSymbols` and
     /// creates the relevant ``SymbolKit/SymbolGraph/Relationship/inContextOf`` relationships.
     ///
     /// Creates symbols of the following kinds:
     /// - ``SymbolKit/SymbolGraph/Symbol/KindIdentifier/unknownExtendedType``
     ///
-    /// If a nested type is extended, but its parent (or another anchestor) is not, this anchestor is not part of the
+    /// If a nested type is extended, but its parent (or another ancestor) is not, this ancestor is not part of the
     /// extension block symbol format. In that case, a extended type symbol of unknown kind is synthesized by
-    /// this function. However, if the anchestor symbol is extended, the `extendedTypeSymbols` should
+    /// this function. However, if the ancestor symbol is extended, the `extendedTypeSymbols` should
     /// already contain the respective symbol. In that case, the ``SymbolKit/SymbolGraph/Relationship/inContextOf``
     /// is attached to the existing symbol.
     ///
@@ -444,7 +444,7 @@ extension ExtendedTypesFormatTransformation {
         var extendedModuleId: String?
         
         // we sort the symbols here because their order is not guaranteed to stay the same
-        // accross compilation processes and choosing the same base symbol (and its USR) is important
+        // across compilation processes and choosing the same base symbol (and its USR) is important
         // to keeping (colliding) links stable
         for extendedTypeSymbolId in extendedTypeSymbolIds.sorted() {
             guard let extendedTypeSymbol = symbolGraph.symbols[extendedTypeSymbolId] else {
@@ -496,9 +496,9 @@ private extension SymbolGraph.Symbol {
         return new
     }
     
-    func replacing<V>(_ keyPath: WritableKeyPath<Self, V>, with closue: (Self) -> V) -> Self {
+    func replacing<V>(_ keyPath: WritableKeyPath<Self, V>, with closure: (Self) -> V) -> Self {
         var new = self
-        new[keyPath: keyPath] = closue(self)
+        new[keyPath: keyPath] = closure(self)
         return new
     }
 }
diff --git a/Sources/SwiftDocC/Model/Rendering/DocumentationContentRenderer.swift b/Sources/SwiftDocC/Model/Rendering/DocumentationContentRenderer.swift
@@ -485,7 +485,7 @@ extension DocumentationContentRenderer {
         /// Will strip the typeIdentifier's precise identifier.
         static func navigatorTitle(for tokens: [DeclarationRenderSection.Token], symbolTitle: String) -> [DeclarationRenderSection.Token] {
             // Replace kind "typeIdentifier" with "identifier" if the title matches the pattern:
-            // [keyword=class,protocol,enum,typealias,etc.][ ]([typeIdentifier=anchestor(Self)][.])*[typeIdentifier=Self]
+            // [keyword=class,protocol,enum,typealias,etc.][ ]([typeIdentifier=ancestor(Self)][.])*[typeIdentifier=Self]
             
             return tokens.mapNameFragmentsToIdentifierKind(matching: symbolTitle)
         }
@@ -499,7 +499,7 @@ extension DocumentationContentRenderer {
             var tokens = tokens
             
             // 1. Replace kind "typeIdentifier" with "identifier" if the title matches the pattern:
-            // [keyword=class,protocol,enum,typealias,etc.][ ]([typeIdentifier=anchestor(Self)][.])*[typeIdentifier=Self]
+            // [keyword=class,protocol,enum,typealias,etc.][ ]([typeIdentifier=ancestor(Self)][.])*[typeIdentifier=Self]
             tokens = tokens.mapNameFragmentsToIdentifierKind(matching: symbolTitle)
             
             
diff --git a/Tests/SwiftDocCTests/Infrastructure/SymbolGraph/ExtendedTypesFormatTransformationTests.swift b/Tests/SwiftDocCTests/Infrastructure/SymbolGraph/ExtendedTypesFormatTransformationTests.swift
@@ -73,8 +73,8 @@ class ExtendedTypesFormatTransformationTests: XCTestCase {
         }
     }
     
-    /// Tests that the transformation synthesizes anchestor extended type symbols if the extended type is a nested type
-    /// and that these synthesized anchestors are merged with pre-existing extended type symbols where applicable.
+    /// Tests that the transformation synthesizes ancestor extended type symbols if the extended type is a nested type
+    /// and that these synthesized ancestors are merged with pre-existing extended type symbols where applicable.
     func testExtendedNestedTypeHierarchySynthesis() throws {
         let contents = twoExtensionBlockSymbolsExtendingSameType(extendedModule: "A", extendedType: "A", withExtensionMembers: false, pathPrefix: ["Unextended", "Extended", "UnextendedInner"])
                         + twoExtensionBlockSymbolsExtendingSameType(extendedModule: "A", extendedType: "Extended", withExtensionMembers: false, pathPrefix: ["Unextended"])
@@ -91,7 +91,7 @@ class ExtendedTypesFormatTransformationTests: XCTestCase {
         
         let extendedTypeUnextended = try XCTUnwrap(graph.symbols.values.first(where: { symbol in symbol.kind.identifier == .unknownExtendedType && symbol.title == "Unextended" }))
         
-        // this anchestor is also extended so its kind should be known
+        // this ancestor is also extended so its kind should be known
         let extendedTypeUnextendedDotExtended = try XCTUnwrap(graph.symbols.values.first(where: { symbol in symbol.kind.identifier == .extendedStructure && symbol.title == "Unextended.Extended" }))
         
         let extendedTypeUnextendedDotExtendedDotUnextendedInner = try XCTUnwrap(graph.symbols.values.first(where: { symbol in symbol.kind.identifier == .unknownExtendedType && symbol.title == "Unextended.Extended.UnextendedInner" }))
