Skip to content

Commit

Permalink
Reapply missed corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
Tom Duncalf committed Jan 21, 2022
1 parent 51086fc commit dcc2bca
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
10 changes: 5 additions & 5 deletions docs/flexible-sync.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ class Subscription {
get createdAt() {}

/**
* The date when this subscription was last update.
* The date when this subscription was last updated.
*
* @type {Date}
* @readonly
Expand Down Expand Up @@ -188,8 +188,8 @@ class BaseSubscriptionSet {
get state() {}

/**
* If `state` is {@link Realm.App.Sync.SubscriptionSetState.Error}, this is a `string`
* representing why the SubscriptionSet is in an error state. `null` if there is no error.
* If `state` is {@link Realm.App.Sync.SubscriptionsState.Error}, this will return a `string`
* representing why the SubscriptionSet is in an error state. `null` is returned if there is no error.
*
* @type {string|null}
* @readonly
Expand Down Expand Up @@ -327,7 +327,7 @@ class SubscriptionSet {
/**
* Update the SubscriptionSet and change this instance to point to the updated SubscriptionSet.
*
* Adding or removing subscriptions from the set set must be performed inside
* Adding or removing subscriptions from the set must be performed inside
* the callback argument of this method, and the mutating methods must be called on
* the `mutableSubs` argument rather than the original {@link Realm.App.Sync.SubscriptionSet} instance.
*
Expand Down Expand Up @@ -369,7 +369,7 @@ class MutableSubscriptionSet {
* Adds a query to the set of active subscriptions. The query will be joined via
* an `OR` operator with any existing queries for the same type.
*
* A query is represented by a {@link Realm.Results} instance returned from {@link Realm#objects},
* A query is represented by a {@link Realm.Results} instance returned from {@link Realm#objects},
* for example: `mutableSubs.add(realm.objects("Cat").filtered("age > 10"));`.
*
* @param {Realm.Results} query A {@link Realm.Results} instance representing the query to subscribe to.
Expand Down
8 changes: 4 additions & 4 deletions src/js_subscriptions.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ namespace js {


/**
* @brief Wrapper class for a single flexible sync subscrpition
* @brief Wrapper class for a single flexible sync subscription
*/
template <typename T>
class Subscription : public realm::sync::Subscription {
Expand All @@ -43,7 +43,7 @@ class Subscription : public realm::sync::Subscription {
};

/**
* @brief Class representing a single flexible sync subscrpition
* @brief Class representing a single flexible sync subscription
*/
template <typename T>
class SubscriptionClass : public ClassDefinition<T, Subscription<T>> {
Expand Down Expand Up @@ -268,7 +268,7 @@ void SubscriptionSetClass<T>::get_empty(ContextType ctx, ObjectType this_object,
*
* @param ctx JS context
* @param this_object \ref ObjectType wrapping the SubscriptionSet
* @param return_value \ref ReturnValue wrapping the error string if any, or null if not
* @param return_value \ref ReturnValue wrapping the error string if it exists, or null if not
*/
template <typename T>
void SubscriptionSetClass<T>::get_error(ContextType ctx, ObjectType this_object, ReturnValue& return_value)
Expand Down Expand Up @@ -529,7 +529,7 @@ class MutableSubscriptionSet : public realm::sync::MutableSubscriptionSet {
*
* @note This is not modelled as an inheritance relationship in JS (using the third
* ClassDefinition template arg to set the parent), because we are not exposing all
* the methods of Subscriptions, so it is not stricly inheritance.
* the methods of Subscriptions, so it is not strictly inheritance.
*/
template <typename T>
class MutableSubscriptionSetClass : public ClassDefinition<T, MutableSubscriptionSet<T>> {
Expand Down
6 changes: 3 additions & 3 deletions types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -764,8 +764,8 @@ declare namespace Realm {
readonly state: SubscriptionsState;

/**
* @returns If `state` is {@link SubscriptionsState.Error}, this is a `string`
* representing why the SubscriptionSet is in an error state. `null` if there is no error.
* @returns If `state` is {@link Realm.App.Sync.SubscriptionsState.Error}, this will return a `string`
* representing why the SubscriptionSet is in an error state. `null` is returned if there is no error.
*/
readonly error: string | null;
}
Expand Down Expand Up @@ -797,7 +797,7 @@ declare namespace Realm {
/**
* Update the SubscriptionSet and change this instance to point to the updated SubscriptionSet.
*
* Adding or removing subscriptions from the set set must be performed inside
* Adding or removing subscriptions from the set must be performed inside
* the callback argument of this method, and the mutating methods must be called on
* the `mutableSubs` argument rather than the original {@link SubscriptionSet} instance.
*
Expand Down

0 comments on commit dcc2bca

Please sign in to comment.