Merge pull request #549 from rgoldberg/538-fix-typos

Fix typos in comments & in documentation.

CONTRIBUTING.md

@@ -8,7 +8,7 @@ We love pull requests from everyone. By participating in this project, you agree
 - [Open an issue](https://github.com/mas-cli/mas/issues/new) to simply ask a question or request a new feature.
 - Search for similar issues with the
 [ERROR MESSAGE](https://github.com/mas-cli/mas/issues?utf8=%E2%9C%93&q=is%3Aopen+ERROR+MESSAGE)
-you are exeriencing.
+you are experiencing.
 - If one doesn't exist, [open a new issue](https://github.com/mas-cli/mas/issues/new)
   - Clearly describe the issue including steps to reproduce when it is a bug.
   - Include the earliest version of `mas` that you know has the issue.

Sources/MasKit/Commands/Lucky.swift

@@ -69,7 +69,7 @@ public struct LuckyCommand: CommandProtocol {
     ///
     /// - Parameters:
     ///   - appId: App identifier
-    ///   - options: command opetions.
+    ///   - options: command options.
     /// - Returns: Result of the operation.
     fileprivate func install(_ appId: UInt64, options: Options) -> Result<Void, MASError> {
         // Try to download applications with given identifiers and collect results

Sources/MasKit/Controllers/AppLibrary.swift

@@ -28,9 +28,9 @@ protocol AppLibrary {
 
 /// Common logic
 extension AppLibrary {
-    /// Finds an app by name.
+    /// Finds an app by ID.
     ///
-    /// - Parameter id: MAS ID for app.
+    /// - Parameter forId: MAS ID for app.
     /// - Returns: Software Product of app if found; nil otherwise.
     func installedApp(forId identifier: UInt64) -> SoftwareProduct? {
         let appId = NSNumber(value: identifier)

Sources/MasKit/Controllers/SoftwareMap.swift

@@ -6,7 +6,7 @@
 //  Copyright © 2020 mas-cli. All rights reserved.
 //
 
-/// Somewhat analygous to CKSoftwareMap
+/// Somewhat analogous to CKSoftwareMap
 protocol SoftwareMap {
     func allSoftwareProducts() -> [SoftwareProduct]
     func product(for bundleIdentifier: String) -> SoftwareProduct?

Sources/MasKit/Formatters/AppListFormatter.swift

@@ -15,8 +15,8 @@ enum AppListFormatter {
 
     /// Formats text output with list results.
     ///
-    /// - Parameter products: List of sortware products app data.
+    /// - Parameter products: List of software products app data.
-    /// - Returns: Multiliune text outoutp.
+    /// - Returns: Multiline text output.
     static func format(products: [SoftwareProduct]) -> String {
         // find longest appName for formatting, default 50
         let maxLength = products.map(\.appNameOrBundleIdentifier.count).max() ?? nameColumnMinWidth

Sources/MasKit/Formatters/SearchResultFormatter.swift

@@ -13,7 +13,7 @@ enum SearchResultFormatter {
     /// Formats text output with search results.
     ///
     /// - Parameter results: Search results with app data
-    /// - Returns: Multiliune text outoutp.
+    /// - Returns: Multiline text output.
     static func format(results: [SearchResult], includePrice: Bool = false) -> String {
         // find longest appName for formatting, default 50
         let maxLength = results.map(\.trackName.count).max() ?? 50

Tests/MasKitTests/Controllers/AppLibraryMock.swift

@@ -27,7 +27,7 @@ class AppLibraryMock: AppLibrary {
     }
 }
 
-/// Members not part of the AppLibrary protocol that are only for test state managment.
+/// Members not part of the AppLibrary protocol that are only for test state management.
 extension AppLibraryMock {
     /// Clears out the list of installed apps.
     func reset() {

docs/sample.swift

@@ -74,7 +74,7 @@ case let .success(data):
     print("The response returned successfully \(data)")
 
 case let .failure(error):
-    print("An error occured: \(error)")
+    print("An error occurred: \(error)")
 }
 
 // MARK: Organization