Apply suggestions from code review

Co-authored-by: Tom Fox <[email protected]>

Author: cbaker6

ParseSwift.playground/Pages/11 - LiveQuery.xcplaygroundpage/Contents.swift

@@ -9,7 +9,7 @@ initializeParse()
 
 //: Create your own ValueTyped ParseObject
 struct GameScore: ParseObject {
-    //: Those are required for Object
+    //: These are required for any Object
     var objectId: String?
     var createdAt: Date?
     var updatedAt: Date?
@@ -64,7 +64,7 @@ subscription.handleEvent { _, event in
     }
 }
 
-//: Now go to your dashboard, goto the GameScore table and add, update, remove rows.
+//: Now go to your dashboard, go to the GameScore table and add, update or remove rows.
 //: You should receive notifications for each.
 
 //: This is how you register to receive notificaitons about being unsubscribed.
@@ -88,10 +88,10 @@ query2.fields("score")
 //: Subscribe to your new query.
 let subscription2 = query2.subscribe!
 
-//: As before, setup your subscription and event handlers
+//: As before, setup your subscription and event handlers.
 subscription2.handleSubscribe { subscribedQuery, isNew in
 
-    //: You can check this subscription is for this query\
+    //: You can check this subscription is for this query.
     if isNew {
         print("Successfully subscribed to new query \(subscribedQuery)")
     } else {
@@ -115,7 +115,7 @@ subscription2.handleEvent { _, event in
     }
 }
 
-//: Now go to your dashboard, goto the GameScore table and add, update, remove rows.
+//: Now go to your dashboard, go to the GameScore table and add, update or remove rows.
 //: You should receive notifications for each, but only with your fields information.
 
 //: This is how you register to receive notificaitons about being unsubscribed.

README.md

@@ -80,7 +80,7 @@ Please checkout the [Swift Playground](https://github.com/parse-community/Parse-
 
 
 ## LiveQuery
-`Query` is one of the key concepts for Parse. It allows you to retrieve `ParseObject`s by specifying some conditions, making it easy to build apps such as a dashboard, a todo list or even some strategy games. However, `Query` is based on a pull model, which is not suitable for apps that need real-time support.
+`Query` is one of the key concepts on the Parse Platform. It allows you to retrieve `ParseObject`s by specifying some conditions, making it easy to build apps such as a dashboard, a todo list or even some strategy games. However, `Query` is based on a pull model, which is not suitable for apps that need real-time support.
 
 Suppose you are building an app that allows multiple users to edit the same file at the same time. `Query` would not be an ideal tool since you can not know when to query from the server to get the updates.
 
@@ -158,4 +158,3 @@ Handling errors is and other events is similar, take a look at the `Subscription
 ### Advanced Usage
 
 You are not limited to a single Live Query Client - you can create multiple instances of `ParseLiveQuery`, use certificate authentication and pinning, receive metrics about each client connection, connect to individual server URLs, and more.
-

Sources/ParseSwift/LiveQuery/Protocols/ParseLiveQueryDelegate.swift

@@ -15,7 +15,7 @@ import Foundation
 public protocol ParseLiveQueryDelegate: AnyObject {
 
     /**
-     Respond to authentication requests from a ParseLiveQuery server. If you become a delegate
+     Respond to authentication requests from a ParseLiveQuery Server. If you become a delegate
      and implement this method you will need to with
      `completionHandler(.performDefaultHandling, nil)` to accept all connections approved
      by the OS. Becoming a delegate allows you to make authentication decisions for all connections in

Sources/ParseSwift/LiveQuery/Protocols/SubscriptionHandlable.swift

@@ -19,7 +19,7 @@ public protocol  SubscriptionHandlable: AnyObject {
     var query: Query<Object> {get set}
 
     /**
-     Tells the handler that an event has been received from the `ParseLiveQuery` server.
+     Tells the handler that an event has been received from the `ParseLiveQuery` Server.
      - parameter eventData: The event data that has been recieved from the server.
      */
     func didReceive(_ eventData: Data) throws

Sources/ParseSwift/LiveQuery/Subscription.swift

@@ -10,7 +10,7 @@
 import Foundation
 
 /**
- Represents an update on a specific object from the `ParseLiveQuery` server.
+ Represents an update on a specific object from the `ParseLiveQuery` Server.
  - Entered: The object has been updated, and is now included in the query.
  - Left:    The object has been updated, and is no longer included in the query.
  - Created: The object has been created, and is a part of the query.
@@ -131,9 +131,9 @@ extension Subscription {
          subscription.handle(Event.Created) { query, object in
             // Called whenever an object is creaated
          }
-     - parameter eventType: The event type to handle. You should pass one of the enum cases in `Event`
-     - parameter handler:   The callback to register
-     - returns: The same subscription, for easy chaining
+     - parameter eventType: The event type to handle. You should pass one of the enum cases in `Event`.
+     - parameter handler: The callback to register.
+     - returns: The same subscription, for easy chaining.
      */
     @discardableResult public func handle(_ eventType: @escaping (T) -> Event<T>,
                                           _ handler: @escaping (Query<T>, T) -> Void) -> Subscription {

Sources/ParseSwift/Storage/PrimitiveObjectStore.swift

@@ -14,7 +14,7 @@ import Foundation
  */
 public protocol PrimitiveObjectStore {
     /// Delete an object from the store.
-    /// - parameter key: The unique key value of the object
+    /// - parameter key: The unique key value of the object.
     mutating func delete(valueFor key: String) throws
     /// Delete all objects from the store.
     mutating func deleteAll() throws

Sources/ParseSwift/Types/Query.swift

@@ -669,7 +669,7 @@ public class Query<T>: Encodable, Equatable where T: ParseObject {
      A variadic list of fields to receive when receiving a `ParseLiveQuery`.
 
      Suppose the `ParseObject` Player contains three fields name, id and age.
-     If you are only interested in the change of the name field, you can set query.fields to "name".
+     If you are only interested in the change of the name field, you can set `query.fields` to "name".
      In this situation, when the change of a Player `ParseObject` fulfills the subscription, only the
      name field will be sent to the clients instead of the full Player `ParseObject`.
      - warning: This is only for `ParseLiveQuery`.
@@ -685,7 +685,7 @@ public class Query<T>: Encodable, Equatable where T: ParseObject {
      A list of fields to receive when receiving a `ParseLiveQuery`.
 
      Suppose the `ParseObject` Player contains three fields name, id and age.
-     If you are only interested in the change of the name field, you can set query.fields to "name".
+     If you are only interested in the change of the name field, you can set `query.fields` to "name".
      In this situation, when the change of a Player `ParseObject` fulfills the subscription, only the
      name field will be sent to the clients instead of the full Player `ParseObject`.
      - warning: This is only for `ParseLiveQuery`.