Merge pull request #1841 from joey-gm/documentation

Documentation - Typos & Consistency Fixes

Author: ahoppen

Changelog.md

@@ -138,8 +138,8 @@ For increased performance, the modelling of the syntax node hierarchy has been s
   ```swift
   let identifierExprSyntax: IdentifierExprSyntax = /* ... */
   let node = Syntax(identifierExprSyntax)
-  node.asProtocol(SyntaxProtocol.self) // returns a IdentifierExprSyntax with static type SyntaxProtocol
-  node.asProtocol(ExprSyntaxProtocol.self) // returns a IdentifierExprSyntax with static type ExprSyntaxProtocol?
+  node.asProtocol(SyntaxProtocol.self) // returns an IdentifierExprSyntax with static type SyntaxProtocol
+  node.asProtocol(ExprSyntaxProtocol.self) // returns an IdentifierExprSyntax with static type ExprSyntaxProtocol?
   ```
 
 

CodeGeneration/Sources/SyntaxSupport/AvailabilityNodes.swift

@@ -60,7 +60,7 @@ public let AVAILABILITY_NODES: [Node] = [
     kind: .availabilityLabeledArgument,
     base: .syntax,
     nameForDiagnostics: "availability argument",
-    documentation: "A argument to an `@available` attribute that consists of a label and a value, e.g. `message: \"This has been deprecated\"`.",
+    documentation: "An argument to an `@available` attribute that consists of a label and a value, e.g. `message: \"This has been deprecated\"`.",
     children: [
       Child(
         name: "Label",

CodeGeneration/Sources/SyntaxSupport/CommonNodes.swift

@@ -191,7 +191,7 @@ public let COMMON_NODES: [Node] = [
     kind: .missingExpr,
     base: .expr,
     nameForDiagnostics: "expression",
-    documentation: "In case the source code is missing a expression, this node stands in place of the missing expression.",
+    documentation: "In case the source code is missing an expression, this node stands in place of the missing expression.",
     children: [
       Child(
         name: "Placeholder",

CodeGeneration/Sources/SyntaxSupport/DeclNodes.swift

@@ -1341,7 +1341,7 @@ public let DECL_NODES: [Node] = [
         name: "Signature",
         kind: .node(kind: .functionSignature),
         nameForDiagnostics: "function signature",
-        documentation: "The arguments of the initializer. While the function signature allows specifying an return clause, doing so is not semantically valid."
+        documentation: "The arguments of the initializer. While the function signature allows specifying a return clause, doing so is not semantically valid."
       ),
       Child(
         name: "GenericWhereClause",
@@ -1353,7 +1353,7 @@ public let DECL_NODES: [Node] = [
       Child(
         name: "Body",
         kind: .node(kind: .codeBlock),
-        documentation: "The initializer’s body. Missing if the initialier is a requirement of a protocol declaration.",
+        documentation: "The initializer’s body. Missing if the initializer is a requirement of a protocol declaration.",
         isOptional: true
       ),
     ]

CodeGeneration/Sources/SyntaxSupport/ExprNodes.swift

@@ -864,7 +864,7 @@ public let EXPR_NODES: [Node] = [
   //   else-clause ';'?
   //
   // This node represents both an 'if' expression, as well as an 'if' statement
-  // when wrapped in a ExpressionStmt node.
+  // when wrapped in an ExpressionStmt node.
   Node(
     kind: .ifExpr,
     base: .expr,
@@ -1652,7 +1652,7 @@ public let EXPR_NODES: [Node] = [
   //   switch-case-list '}' ';'?
   //
   // This node represents both a 'switch' expression, as well as a 'switch'
-  // statement when wrapped in a ExpressionStmt node.
+  // statement when wrapped in an ExpressionStmt node.
   Node(
     kind: .switchExpr,
     base: .expr,

CodeGeneration/Sources/SyntaxSupport/Node.swift

@@ -16,7 +16,7 @@ import SwiftSyntax
 /// The definition of a syntax node that, when generated, conforms to
 /// `SyntaxProtocol`.
 ///
-/// There are two fundemantally different kinds of nodes:
+/// There are two fundamentally different kinds of nodes:
 ///  - Layout nodes contain a fixed number of children of possibly different,
 ///    but fixed types.
 ///  - Collection nodes contains an arbitrary number of children but all those
@@ -253,14 +253,14 @@ public struct CollectionNode {
     self.node = node
   }
 
-  /// Allow transparent accesss to the properties of the underlying `Node`.
+  /// Allow transparent access to the properties of the underlying `Node`.
   public subscript<T>(dynamicMember keyPath: KeyPath<Node, T>) -> T {
     return node[keyPath: keyPath]
   }
 
   /// The kinds the elements can have.
   ///
-  /// This can be more than one in which case each element an have either of
+  /// This can be more than one in which case each element can have either of
   /// these kinds.
   public var elementChoices: [SyntaxNodeKind] {
     switch node.data {

CodeGeneration/Sources/SyntaxSupport/SyntaxNodeKind.swift

@@ -304,7 +304,7 @@ public enum SyntaxNodeKind: String, CaseIterable {
   case yieldList
   case yieldStmt
 
-  // Nodes that have special handling throught the codebase
+  // Nodes that have special handling throughout the codebase
 
   case syntax
   case syntaxCollection

CodeGeneration/Sources/Utils/CodeGenerationFormat.swift

@@ -92,7 +92,7 @@ public class CodeGenerationFormat: BasicFormat {
   // MARK: - Private
 
   private func shouldBeSeparatedByTwoNewlines(node: CodeBlockItemSyntax) -> Bool {
-    // First item in the ``CodeBlockItemListSyntax`` don't need a newline or identation if the parent is a ``SourceFileSyntax``.
+    // First item in the ``CodeBlockItemListSyntax`` don't need a newline or indentation if the parent is a ``SourceFileSyntax``.
     // We want to group imports so newline between them should be omitted
     return node.parent?.as(CodeBlockItemListSyntax.self)?.first == node || node.item.is(ImportDeclSyntax.self)
   }

CodeGeneration/Sources/Utils/SyntaxBuildableChild.swift

@@ -111,7 +111,7 @@ public extension Child {
 
     let choicesTexts: [String]
     if tokenCanContainArbitraryText {
-      // Don't generate an precondition statement if token can contain arbitrary text.
+      // Don't generate a precondition statement if token can contain arbitrary text.
       return nil
     } else if !choices.isEmpty {
       choicesTexts = choices.compactMap {

CodeGeneration/Sources/Utils/SyntaxBuildableType.swift

@@ -140,7 +140,7 @@ public struct SyntaxBuildableType: Hashable {
     return optionalWrapped(type: SimpleTypeIdentifierSyntax(name: .identifier(syntaxBaseName)))
   }
 
-  /// The type that is used for paramters in SwiftSyntaxBuilder that take this
+  /// The type that is used for parameters in SwiftSyntaxBuilder that take this
   /// type of syntax node.
   public var parameterBaseType: String {
     if isBaseType {