Use inclusive language (#790)

* Use inclusive language

* update formatting to be the same as in other projects

* Update scripts/validate_language.sh

Co-authored-by: Yim Lee <yim_lee@apple.com>

Co-authored-by: Yim Lee <yim_lee@apple.com>

Author: ktoso

.gitignore

@@ -29,4 +29,4 @@ IntegrationTests/tests_04_cluster/.build
 .swiftpm/
 Package.resolved
 
-.GenActorInstruments-sanity.instrpkg 
+.GenActorInstruments-soundness.instrpkg

CONTRIBUTING.md

@@ -60,12 +60,12 @@ We require that your commit messages match our template. The easiest way to do t
 
     git config commit.template dev/git.commit.template
 
-### Run `./scripts/sanity.sh`
+### Run `./scripts/soundness.sh`
 
-The scripts directory contains a [sanity.sh script](https://github.com/apple/swift-metrics/blob/master/scripts/sanity.sh) 
+The scripts directory contains a [soundness.sh script](https://github.com/apple/swift-metrics/blob/master/scripts/soundness.sh) 
 that enforces additional checks, like license headers and formatting style.
 
-Please make sure to `./scripts/sanity.sh` before pushing a change upstream, otherwise it is likely the PR validation will fail
+Please make sure to `./scripts/soundness.sh` before pushing a change upstream, otherwise it is likely the PR validation will fail
 on minor changes such as a missing `self.` or similar formatting issues.
 
 > The script also executes the above mentioned `generate_linux_tests.rb`.
@@ -76,8 +76,8 @@ For frequent contributors, we recommend adding the script as a [git pre-push hoo
 cat << EOF > .git/hooks/pre-push
 #!/bin/bash
 
-if [[ -f "scripts/sanity.sh" ]]; then
-  scripts/sanity.sh
+if [[ -f "scripts/soundness.sh" ]]; then
+  scripts/soundness.sh
 fi
 EOF
 ```

Docs/clustering.adoc

@@ -261,7 +261,7 @@ In these scenarios it is most useful to work with subscriptions and react to the
 
 ==== Membership Snapshot
 
-Sometimes however, one just wants to perform a sanity check or printout without having to subscribe to the membership events actively.
+Sometimes however, one just wants to perform a check or printout without having to subscribe to the membership events actively.
 Note, however, that no strong guarantees are made about "how up to date" that value is, and even the moment after one has checked it, it may have already changed, e.g. another member has become leader.
 Take this into consideration when opting to use this style of `Cluster.Membership` interaction.
 

Instruments/GenActorInstruments/Package.swift

@@ -4,12 +4,10 @@
 import PackageDescription
 
 var targets: [PackageDescription.Target] = [
-
     .target(
         name: "SwiftyInstrumentsPackageDefinition",
         dependencies: []
     ),
-
 ]
 
 #if os(macOS) || os(iOS) || os(tvOS) || os(watchOS)
@@ -19,8 +17,7 @@ var targets: [PackageDescription.Target] = [
 
 targets.append(
     contentsOf: [
-
-        // ==== ----------------------------------------------------------------------------------------------------------------
+        // ==== --------------------------------------------------------------------------------------------------------
         // MARK: Actor Instruments Package Definition
 
         .target(
@@ -31,7 +28,7 @@ targets.append(
             ]
         ),
 
-        // ==== ------------------------------------------------------------------------------------------------------------
+        // ==== --------------------------------------------------------------------------------------------------------
         // MARK: GenActorInstruments
 
         .target(
@@ -54,7 +51,7 @@ var dependencies: [Package.Dependency] = [
 
     // ~~~ for rendering the PackageDefinition XML ~~~
     .package(url: "https://github.com/MaxDesiatov/XMLCoder.git", from: "0.11.1"), // MIT
-    .package(url: "https://github.com/apple/swift-argument-parser", .exact("0.0.6")), // not API stable, Apache v2
+    .package(url: "https://github.com/apple/swift-argument-parser", .upToNextMinor(from: "0.3.2")), // not API stable, Apache v2
 ]
 
 let package = Package(

Instruments/GenActorInstruments/Sources/ActorInstrumentsPackageDefinition/ActorInstrumentsPackageDefinition.swift

@@ -231,7 +231,6 @@ extension Column {
         type: .uint32,
         expression: "?regs"
     )
-
 }
 
 @available(OSX 10.14, *)
@@ -578,7 +577,6 @@ public struct ActorInstrumentsPackageDefinition {
         }
     }
 
-
     public var packageDefinition: PackageDefinition {
         PackageDefinition(
             id: packageID,
@@ -598,7 +596,7 @@ public struct ActorInstrumentsPackageDefinition {
 
             // messages (ask)
             Schemas.actorAskedInterval
-            
+
             // watches
             Schemas.actorWatches
 
@@ -634,7 +632,7 @@ public struct ActorInstrumentsPackageDefinition {
                         table: tableActorLifecycleSpawns
                     ) {
                         Graph.Histogram(
-                            // TODO slice?
+                            // TODO: slice?
                             nanosecondsPerBucket: Int(TimeAmount.seconds(1).nanoseconds),
                             mode: .count(.actorPath)
                         )
@@ -647,8 +645,8 @@ public struct ActorInstrumentsPackageDefinition {
                         Graph.Histogram(
                             slice: [
                                 Instrument.Slice(
-                                    column: .actorStopReason, "stop" // FIXME:also count crashes as stops
-                                )
+                                    column: .actorStopReason, "stop" // FIXME: also count crashes as stops
+                                ),
                             ],
                             nanosecondsPerBucket: Int(TimeAmount.seconds(1).nanoseconds),
                             mode: .count(.actorPath)

Instruments/GenActorInstruments/Sources/ActorInstrumentsPackageDefinition/main.swift

@@ -12,8 +12,8 @@
 //
 //===----------------------------------------------------------------------===//
 
-import Logging
 import GenActorInstruments
+import Logging
 
 LoggingSystem.bootstrap(StreamLogHandler.standardError)
 

Instruments/GenActorInstruments/Sources/GenActorInstruments/GenerateActorInstrumentsPackageDefinition.swift

@@ -12,12 +12,12 @@
 //
 //===----------------------------------------------------------------------===//
 
-import SwiftyInstrumentsPackageDefinition
 import ArgumentParser
 import DistributedActors
 import Foundation
-import XMLCoder
 import Logging
+import SwiftyInstrumentsPackageDefinition
+import XMLCoder
 
 public struct InstrumentsPackageDefinitionGenerator {
     let log: Logger = Logger(label: "gen-package-def")
@@ -45,12 +45,10 @@ public struct InstrumentsPackageDefinitionGenerator {
             self.log.info("Rendered: \(self.settings.output)")
             self.log.info("To format the generates XML you may want to pipe through: xmllint --output Instruments/ActorInstruments/ActorInstruments/ActorInstruments.instrpkg --format -")
 
-
             self.log.info("""
-                          To generate package using Xcode: 
-                              open ./Instruments/ActorInstruments/ActorInstruments.xcodeproj
-                          """)
-
+            To generate package using Xcode: 
+                open ./Instruments/ActorInstruments/ActorInstruments.xcodeproj
+            """)
 
             if self.settings.stdout {
                 print(renderedXML)
@@ -89,4 +87,3 @@ extension InstrumentsPackageDefinitionGenerator {
         var output: String
     }
 }
-

Instruments/GenActorInstruments/Sources/SwiftyInstrumentsPackageDefinition/InstrumentsPackageDefinition+Coding.swift

@@ -317,7 +317,6 @@ extension PackageDefinition.Instrument.ImportParameter {
         try container.encode(self.fromScope, forKey: .fromScope)
         try container.encode(self.name, forKey: .name)
     }
-
 }
 
 extension PackageDefinition.Instrument.CreateTable {
@@ -416,7 +415,7 @@ extension PackageDefinition.Instrument.Graph.Lane {
 
         try self.plots.forEach { try container.encode($0, forKey: .plot) }
         try self.plotTemplates.forEach { try container.encode($0, forKey: .plotTemplates) }
-         try self.histograms.forEach { try container.encode($0, forKey: .histograms)}
+        try self.histograms.forEach { try container.encode($0, forKey: .histograms) }
         // try self.histogramsTemplates.forEach { try container.encode($0, forKey: .histogramsTemplates)} // TODO: implement this
     }
 }

Instruments/GenActorInstruments/Sources/SwiftyInstrumentsPackageDefinition/InstrumentsPackageDefinition.swift

@@ -238,7 +238,7 @@ extension PackageDefinition {
                     type: .duration, // TODO: is this right?
                     expression: "?duration",
                     hidden: true
-                )
+                ),
             ]
             self.collect(builder())
 
@@ -263,7 +263,7 @@ extension PackageDefinition {
                 for v in variables {
                     precondition(
                         "\(self.startPattern)".contains("\(v)") ||
-                        "\(self.endPattern)".contains("\(v)"),
+                            "\(self.endPattern)".contains("\(v)"),
                         """
                         Variable '?\(v)' must appear in pattern to be used in a later expression.
                         Start Pattern: \(self.startPattern)
@@ -357,7 +357,7 @@ extension PackageDefinition {
                     hidden: true
                 ),
             ]
-            
+
             self.collect(builder())
             self.validate()
         }
@@ -414,7 +414,7 @@ public struct Mnemonic: Encodable, ExpressibleByStringLiteral, Hashable, CustomS
     public let name: String
 
     /// The mnemonic was set via an explicit reference to a Column or similar,
-    /// and thus we should assume we can run sanity checks including it (e.g. if a targeted schema
+    /// and thus we should assume we can run checks including it (e.g. if a targeted schema
     /// includes a column identified with this mnemonic etc).
     public var definedUsingWellTypedReference: Bool
 
@@ -532,7 +532,7 @@ public struct Column: Encodable, SchemaElementConvertible, MnemonicConvertible {
     }
 
     var notHidden: Bool {
-        return !self.hidden
+        !self.hidden
     }
 
     public func asSchemaElement() -> SchemaElement {
@@ -1197,8 +1197,8 @@ extension PackageDefinition.Instrument {
         ///
         /// - SeeAlso: https://help.apple.com/instruments/developer/mac/current/#/dev455934374
         public struct Histogram: Encodable, GraphLaneElementConvertible {
-             /// Specifies a filter that should be applied to the input data in table-ref
-             public var slice: [Slice] // 1-3
+            /// Specifies a filter that should be applied to the input data in table-ref
+            public var slice: [Slice] // 1-3
 
             // /// Flags the histogram as being ideal for a particular time resolution.
             // best-for-resolution {1,3}
@@ -1540,7 +1540,7 @@ extension PackageDefinition.Instrument {
         func hasColumn(_ col: Mnemonic) -> Bool {
             self.schemaRef.hasColumn(col)
         }
-        
+
         public init(_ table: PackageDefinition.Instrument.CreateTable) {
             self.id = table.id
             self.schemaRef = table.schemaRef

IntegrationTests/disabled_tests_03_xpc_actorable/it_XPCActorable_echo_api/XPCEchoServiceProtocol.swift

@@ -16,7 +16,6 @@ import DistributedActors
 import DistributedActorsXPC
 
 public protocol XPCEchoServiceProtocol: XPCActorableProtocol {
-
     // @actor
     func echo(string: String) -> String