From bbc7179b02a0f25061b7777e3a58fd9063c1fe99 Mon Sep 17 00:00:00 2001 From: Zach Date: Thu, 19 Oct 2023 19:11:32 -0600 Subject: [PATCH] Fix parameter documentation (#5) --- Sources/Waiter/Wait.swift | 20 ++++++------- Sources/Waiter/Waitable.swift | 56 +++++++++++++++++------------------ 2 files changed, 38 insertions(+), 38 deletions(-) diff --git a/Sources/Waiter/Wait.swift b/Sources/Waiter/Wait.swift index cec91f8..5f49d60 100644 --- a/Sources/Waiter/Wait.swift +++ b/Sources/Waiter/Wait.swift @@ -27,11 +27,11 @@ public enum WaitError: LocalizedError { Waits asynchronously for the value of the specified key path to satisfy the provided condition. - Parameters: - - `on`: The object to wait on. - - `for`: The key path of the value to wait for. - - `duration`: The maximum amount of time to wait for the value to change. - - `interval`: The interval at which to check the value. - - `expecting`: The closure that determines whether the value satisfies the condition. + - on: The object to wait on. + - for: The key path of the value to wait for. + - duration: The maximum amount of time to wait for the value to change. + - interval: The interval at which to check the value. + - expecting: The closure that determines whether the value satisfies the condition. - Returns: The value of the key path once it satisfies the condition. @@ -59,11 +59,11 @@ public func wait( Waits asynchronously for the value of the specified key path to become equal to the provided value. - Parameters: - - `on`: The object to wait on. - - `for`: The key path of the value to wait for. - - `duration`: The maximum amount of time to wait for the value to change. - - `interval`: The interval at which to check the value. - - `expecting`: The expected value to wait for. + - on: The object to wait on. + - for: The key path of the value to wait for. + - duration: The maximum amount of time to wait for the value to change. + - interval: The interval at which to check the value. + - expecting: The expected value to wait for. - Returns: The value of the key path once it becomes equal to the provided value. diff --git a/Sources/Waiter/Waitable.swift b/Sources/Waiter/Waitable.swift index 6e1fd60..39993c4 100644 --- a/Sources/Waiter/Waitable.swift +++ b/Sources/Waiter/Waitable.swift @@ -12,11 +12,11 @@ public protocol Waitable { Waits asynchronously for the value of the specified key path to satisfy the provided condition. - Parameters: - - `on`: The object to wait on. - - `for`: The key path of the value to wait for. - - `duration`: The maximum amount of time to wait for the value to change. - - `interval`: The interval at which to check the value. - - `expecting`: The closure that determines whether the value satisfies the condition. + - on: The object to wait on. + - for: The key path of the value to wait for. + - duration: The maximum amount of time to wait for the value to change. + - interval: The interval at which to check the value. + - expecting: The closure that determines whether the value satisfies the condition. - Returns: The value of the key path once it satisfies the condition. @@ -35,11 +35,11 @@ public protocol Waitable { Waits asynchronously for the value of the specified key path to become equal to the provided value. - Parameters: - - `on`: The object to wait on. - - `for`: The key path of the value to wait for. - - `duration`: The maximum amount of time to wait for the value to change. - - `interval`: The interval at which to check the value. - - `expecting`: The expected value to wait for. + - on: The object to wait on. + - for: The key path of the value to wait for. + - duration: The maximum amount of time to wait for the value to change. + - interval: The interval at which to check the value. + - expecting: The expected value to wait for. - Returns: The value of the key path once it becomes equal to the provided value. @@ -60,11 +60,11 @@ extension Waitable { Waits asynchronously for the value of the specified key path to satisfy the provided condition. - Parameters: - - `on`: The object to wait on. - - `for`: The key path of the value to wait for. - - `duration`: The maximum amount of time to wait for the value to change. - - `interval`: The interval at which to check the value. - - `expecting`: The closure that determines whether the value satisfies the condition. + - on: The object to wait on. + - for: The key path of the value to wait for. + - duration: The maximum amount of time to wait for the value to change. + - interval: The interval at which to check the value. + - expecting: The closure that determines whether the value satisfies the condition. - Returns: The value of the key path once it satisfies the condition. @@ -91,11 +91,11 @@ extension Waitable { Waits asynchronously for the value of the specified key path to become equal to the provided value. - Parameters: - - `on`: The object to wait on. - - `for`: The key path of the value to wait for. - - `duration`: The maximum amount of time to wait for the value to change. - - `interval`: The interval at which to check the value. - - `expecting`: The expected value to wait for. + - on: The object to wait on. + - for: The key path of the value to wait for. + - duration: The maximum amount of time to wait for the value to change. + - interval: The interval at which to check the value. + - expecting: The expected value to wait for. - Returns: The value of the key path once it becomes equal to the provided value. @@ -124,10 +124,10 @@ extension Waitable where Self: AnyObject { Waits asynchronously for the value of the specified key path to satisfy the provided condition. - Parameters: - - `for`: The key path of the value to wait for. - - `duration`: The maximum amount of time to wait for the value to change. - - `interval`: The interval at which to check the value. - - `expecting`: The closure that determines whether the value satisfies the condition. + - for: The key path of the value to wait for. + - duration: The maximum amount of time to wait for the value to change. + - interval: The interval at which to check the value. + - expecting: The closure that determines whether the value satisfies the condition. - Returns: The value of the key path once it satisfies the condition. @@ -153,10 +153,10 @@ extension Waitable where Self: AnyObject { Waits asynchronously for the value of the specified key path to become equal to the provided value. - Parameters: - - `for`: The key path of the value to wait for. - - `duration`: The maximum amount of time to wait for the value to change. - - `interval`: The interval at which to check the value. - - `expecting`: The expected value to wait for. + - for: The key path of the value to wait `for. + - duration: The maximum amount of time to wait for the value to change. + - interval: The interval at which to check the value. + - expecting: The expected value to wait for. - Returns: The value of the key path once it becomes equal to the provided value.