docs: improve documentation sections (#276)

* docs: improve ParseUser documentation

* more docs

* fixes

* conform to protocol

* More doc updates

* bump version

* Remove codecov filter

* nits

Author: cbaker6

.github/workflows/ci.yml

@@ -25,7 +25,6 @@ jobs:
       uses: sersoft-gmbh/swift-coverage-action@v2
       id: coverage-files
       with:
-        target-name-filter: '^ParseSwift$'
         format: lcov
         search-paths: ./DerivedData
       env:

CHANGELOG.md

@@ -2,9 +2,15 @@
 
 ### main
 
-[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/2.2.2...main)
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/2.2.3...main)
 * _Contributing to this repo? Add info about your change here to be included in the next release_
 
+### 2.2.3
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/2.2.2...2.2.3)
+
+__Fixes__
+- Improve dpcumentation ([#276](https://github.com/parse-community/Parse-Swift/pull/276)), thanks to [Corey Baker](https://github.com/cbaker6).
+
 ### 2.2.2
 [Full Changelog](https://github.com/parse-community/Parse-Swift/compare/2.2.1...2.2.2)
 

ParseSwift.playground/Pages/13 - Operations.xcplaygroundpage/Contents.swift

@@ -21,7 +21,7 @@ struct GameScore: ParseObject {
     var ACL: ParseACL?
 
     //: Your own properties.
-    var score: Int = 0
+    var score: Int? = 0
 }
 
 //: It's recommended to place custom initializers in an extension
@@ -45,7 +45,7 @@ do {
     savedScore = try GameScore(score: 102).save()
 } catch {
     savedScore = nil
-    fatalError("Error saving: \(error)")
+    assertionFailure("Error saving: \(error)")
 }
 
 //: Then we will increment the score.
@@ -69,8 +69,20 @@ do {
     print(error)
 }
 
-//: There are other operations: add/remove/delete objects from `ParseObject`s.
+//: You can also remove a value for a property using unset.
+let unsetOperation = savedScore
+    .operation.unset(("score", \.score))
+do {
+    let updatedScore = try unsetOperation.save()
+    print("Updated score: \(updatedScore). Check the new score on Parse Dashboard.")
+} catch {
+    print(error)
+}
+
+//: There are other operations: set/forceSet/unset/add/remove, etc. objects from `ParseObject`s.
 //: In fact, the `users` and `roles` relations from `ParseRoles` used the add/remove operations.
+//: Multiple operations can be chained together. See:
+//: https://github.com/parse-community/Parse-Swift/pull/268#issuecomment-955714414
 let operations = savedScore.operation
 
 //: Example: operations.add("hello", objects: ["test"]).

Sources/ParseSwift/Authentication/3rd Party/ParseApple/ParseApple+async.swift

@@ -11,7 +11,7 @@ import Foundation
 
 @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
 public extension ParseApple {
-    // MARK: Login - Async/Await
+    // MARK: Async/Await
 
     /**
      Login a `ParseUser` *asynchronously* using Apple authentication.
@@ -51,7 +51,6 @@ public extension ParseApple {
 
 @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
 public extension ParseApple {
-    // MARK: Link - Async/Await
 
     /**
      Link the *current* `ParseUser` *asynchronously* using Apple authentication.

Sources/ParseSwift/Authentication/3rd Party/ParseApple/ParseApple+combine.swift

@@ -11,7 +11,7 @@ import Foundation
 import Combine
 
 public extension ParseApple {
-    // MARK: Login - Combine
+    // MARK: Combine
 
     /**
      Login a `ParseUser` *asynchronously* using Apple authentication. Publishes when complete.
@@ -48,7 +48,6 @@ public extension ParseApple {
 }
 
 public extension ParseApple {
-    // MARK: Link - Combine
 
     /**
      Link the *current* `ParseUser` *asynchronously* using Apple authentication. Publishes when complete.

Sources/ParseSwift/Authentication/3rd Party/ParseFacebook/ParseFacebook+async.swift

@@ -11,7 +11,7 @@ import Foundation
 
 @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
 public extension ParseFacebook {
-    // MARK: Login - Async/Await
+    // MARK: Async/Await
 
     /**
      Login a `ParseUser` *asynchronously* using Facebook authentication for limited login.
@@ -75,7 +75,6 @@ public extension ParseFacebook {
 
 @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
 public extension ParseFacebook {
-    // MARK: Link - Async/Await
     /**
      Link the *current* `ParseUser` *asynchronously* using Facebook authentication for limited login.
      - parameter userId: The `userId` from `FacebookSDK`.

Sources/ParseSwift/Authentication/3rd Party/ParseFacebook/ParseFacebook+combine.swift

@@ -11,7 +11,7 @@ import Foundation
 import Combine
 
 public extension ParseFacebook {
-    // MARK: Login - Combine
+    // MARK: Combine
     /**
      Login a `ParseUser` *asynchronously* using Facebook authentication for limited login. Publishes when complete.
      - parameter userId: The `userId` from `FacebookSDK`.
@@ -70,7 +70,6 @@ public extension ParseFacebook {
 }
 
 public extension ParseFacebook {
-    // MARK: Link - Combine
     /**
      Link the *current* `ParseUser` *asynchronously* using Facebook authentication for limited login.
      Publishes when complete.

Sources/ParseSwift/Authentication/3rd Party/ParseLDAP/ParseLDAP+async.swift

@@ -11,7 +11,7 @@ import Foundation
 
 @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
 public extension ParseLDAP {
-    // MARK: Login - Async/Await
+    // MARK: Async/Await
     /**
      Login a `ParseUser` *asynchronously* using LDAP authentication.
      - parameter id: The id of the `user`.
@@ -50,7 +50,6 @@ public extension ParseLDAP {
 
 @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
 public extension ParseLDAP {
-    // MARK: Link - Async/Await
     /**
      Link the *current* `ParseUser` *asynchronously* using LDAP authentication.
      - parameter id: The id of the `user`.

Sources/ParseSwift/Authentication/3rd Party/ParseLDAP/ParseLDAP+combine.swift

@@ -11,7 +11,7 @@ import Foundation
 import Combine
 
 public extension ParseLDAP {
-    // MARK: Login - Combine
+    // MARK: Combine
     /**
      Login a `ParseUser` *asynchronously* using LDAP authentication. Publishes when complete.
      - parameter id: The id of the `user`.
@@ -47,7 +47,6 @@ public extension ParseLDAP {
 }
 
 public extension ParseLDAP {
-    // MARK: Link - Combine
     /**
      Link the *current* `ParseUser` *asynchronously* using LDAP authentication. Publishes when complete.
      - parameter id: The id of the `user`.

Sources/ParseSwift/Authentication/3rd Party/ParseTwitter/ParseTwitter+async.swift

@@ -11,7 +11,7 @@ import Foundation
 
 @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
 public extension ParseTwitter {
-    // MARK: Login - Async/Await
+    // MARK: Async/Await
 
     /**
      Login a `ParseUser` *asynchronously* using Twitter authentication.
@@ -63,7 +63,6 @@ public extension ParseTwitter {
 
 @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
 public extension ParseTwitter {
-    // MARK: Link - Async/Await
 
     /**
      Link the *current* `ParseUser` *asynchronously* using Twitter authentication.