From 6f22f9077f664a918106a39a67e6f8aa62d63bbb Mon Sep 17 00:00:00 2001 From: Marat Al Date: Tue, 10 Dec 2024 16:05:52 +0100 Subject: [PATCH] Addressed review comments. --- Sources/AblyChat/Presence.swift | 8 ++++---- Sources/AblyChat/RoomOptions.swift | 16 ++++++++-------- Sources/AblyChat/Typing.swift | 2 +- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/Sources/AblyChat/Presence.swift b/Sources/AblyChat/Presence.swift index 3032872..e8c0aac 100644 --- a/Sources/AblyChat/Presence.swift +++ b/Sources/AblyChat/Presence.swift @@ -145,10 +145,10 @@ public protocol Presence: AnyObject, Sendable, EmitsDiscontinuities { func leave(data: PresenceData?) async throws /** - * Subscribes a given listener to a particular presense event in the chat room. + * Subscribes a given listener to a particular presence event in the chat room. * * - Parameters: - * - event: A single presense event type ``PresenceEventType`` to subscribe to. + * - event: A single presence event type ``PresenceEventType`` to subscribe to. * - bufferingPolicy: The ``BufferingPolicy`` for the created subscription. * * - Returns: A subscription `AsyncSequence` that can be used to iterate through ``PresenceEvent`` events. @@ -156,10 +156,10 @@ public protocol Presence: AnyObject, Sendable, EmitsDiscontinuities { func subscribe(event: PresenceEventType, bufferingPolicy: BufferingPolicy) async -> Subscription /** - * Subscribes a given listener to different presense events in the chat room. + * Subscribes a given listener to different presence events in the chat room. * * - Parameters: - * - events: An array of presense event types ``PresenceEventType`` to subscribe to. + * - events: An array of presence event types ``PresenceEventType`` to subscribe to. * - bufferingPolicy: The ``BufferingPolicy`` for the created subscription. * * - Returns: A subscription `AsyncSequence` that can be used to iterate through ``PresenceEvent`` events. diff --git a/Sources/AblyChat/RoomOptions.swift b/Sources/AblyChat/RoomOptions.swift index 0392186..c64d024 100644 --- a/Sources/AblyChat/RoomOptions.swift +++ b/Sources/AblyChat/RoomOptions.swift @@ -5,26 +5,26 @@ import Foundation */ public struct RoomOptions: Sendable, Equatable { /** - * The presence options for the room. To enable presence in the room, set this property. You may - * use ``RoomOptions/allFeaturesEnabled`` to enable presence with default options. + * The presence options for the room. To enable presence in the room, set this property. + * Alternatively, you may use ``RoomOptions/allFeaturesEnabled`` to enable presence with the default options. */ public var presence: PresenceOptions? /** - * The typing options for the room. To enable typing in the room, set this property. You may - * use ``RoomOptions/allFeaturesEnabled`` to enable typing with default options. + * The typing options for the room. To enable typing in the room, set this property. + * Alternatively, you may use ``RoomOptions/allFeaturesEnabled`` to enable typing with the default options. */ public var typing: TypingOptions? /** - * The reactions options for the room. To enable reactions in the room, set this property. You may - * use ``RoomOptions/allFeaturesEnabled`` to enable reactions with default options. + * The reactions options for the room. To enable reactions in the room, set this property. + * Alternatively, you may use ``RoomOptions/allFeaturesEnabled`` to enable reactions with the default options. */ public var reactions: RoomReactionsOptions? /** - * The occupancy options for the room. To enable occupancy in the room, set this property. You may - * use ``RoomOptions/allFeaturesEnabled`` to enable occupancy with default options. + * The occupancy options for the room. To enable occupancy in the room, set this property. + * Alternatively, you may use ``RoomOptions/allFeaturesEnabled`` to enable occupancy with the default options. */ public var occupancy: OccupancyOptions? diff --git a/Sources/AblyChat/Typing.swift b/Sources/AblyChat/Typing.swift index 07d29d9..49b9d43 100644 --- a/Sources/AblyChat/Typing.swift +++ b/Sources/AblyChat/Typing.swift @@ -35,7 +35,7 @@ public protocol Typing: AnyObject, Sendable, EmitsDiscontinuities { * contains a list of userIds who are currently typing. * * The timeout is configurable through the ``TypingOptions/timeout`` parameter. - * If the current user is already typing, it will reset the timer and being counting down again without emitting a new event. + * If the current user is already typing, it will reset the timer and begin counting down again without emitting a new event. * * - Throws: An `ARTErrorInfo`. */