Skip to content

Commit 6334c12

Browse files
authored
Update documentation of refresh(_:) (#123)
1 parent 240049d commit 6334c12

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

Sources/Atoms/Context/AtomContext.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ public protocol AtomContext {
6464

6565
/// Refreshes and then returns the value associated with the given refreshable atom.
6666
///
67-
/// This method only accepts refreshable atoms such as types conforming to:
67+
/// This method accepts only asynchronous atoms such as types conforming to:
6868
/// ``TaskAtom``, ``ThrowingTaskAtom``, ``AsyncSequenceAtom``, ``PublisherAtom``.
6969
/// It refreshes the value for the given atom and then returns, so the caller can await until
7070
/// the atom completes the update.

Sources/Atoms/Context/AtomCurrentContext.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ public struct AtomCurrentContext<Coordinator>: AtomContext {
8282

8383
/// Refreshes and then returns the value associated with the given refreshable atom.
8484
///
85-
/// This method only accepts refreshable atoms such as types conforming to:
85+
/// This method accepts only asynchronous atoms such as types conforming to:
8686
/// ``TaskAtom``, ``ThrowingTaskAtom``, ``AsyncSequenceAtom``, ``PublisherAtom``.
8787
/// It refreshes the value for the given atom and then returns, so the caller can await until
8888
/// the atom completes the update.

Sources/Atoms/Context/AtomTestContext.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ public struct AtomTestContext: AtomWatchableContext {
214214

215215
/// Refreshes and then returns the value associated with the given refreshable atom.
216216
///
217-
/// This method only accepts refreshable atoms such as types conforming to:
217+
/// This method accepts only asynchronous atoms such as types conforming to:
218218
/// ``TaskAtom``, ``ThrowingTaskAtom``, ``AsyncSequenceAtom``, ``PublisherAtom``.
219219
/// It refreshes the value for the given atom and then returns, so the caller can await until
220220
/// the atom completes the update.

Sources/Atoms/Context/AtomTransactionContext.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ public struct AtomTransactionContext<Coordinator>: AtomWatchableContext {
9090

9191
/// Refreshes and then returns the value associated with the given refreshable atom.
9292
///
93-
/// This method only accepts refreshable atoms such as types conforming to:
93+
/// This method accepts only asynchronous atoms such as types conforming to:
9494
/// ``TaskAtom``, ``ThrowingTaskAtom``, ``AsyncSequenceAtom``, ``PublisherAtom``.
9595
/// It refreshes the value for the given atom and then returns, so the caller can await until
9696
/// the atom completes the update.

Sources/Atoms/Context/AtomViewContext.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ public struct AtomViewContext: AtomWatchableContext {
8989

9090
/// Refreshes and then returns the value associated with the given refreshable atom.
9191
///
92-
/// This method only accepts refreshable atoms such as types conforming to:
92+
/// This method accepts only asynchronous atoms such as types conforming to:
9393
/// ``TaskAtom``, ``ThrowingTaskAtom``, ``AsyncSequenceAtom``, ``PublisherAtom``.
9494
/// It refreshes the value for the given atom and then returns, so the caller can await until
9595
/// the atom completes the update.

0 commit comments

Comments
 (0)