Skip to content

Update documentation of refresh(_:) #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 24, 2024
Merged

Update documentation of refresh(_:) #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Sources/Atoms/Context/AtomContext.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public protocol AtomContext {

/// Refreshes and then returns the value associated with the given refreshable atom.
///
/// This method only accepts refreshable atoms such as types conforming to:
/// This method accepts only asynchronous atoms such as types conforming to:
/// ``TaskAtom``, ``ThrowingTaskAtom``, ``AsyncSequenceAtom``, ``PublisherAtom``.
/// It refreshes the value for the given atom and then returns, so the caller can await until
/// the atom completes the update.
Expand Down
2 changes: 1 addition & 1 deletion Sources/Atoms/Context/AtomCurrentContext.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ public struct AtomCurrentContext<Coordinator>: AtomContext {

/// Refreshes and then returns the value associated with the given refreshable atom.
///
/// This method only accepts refreshable atoms such as types conforming to:
/// This method accepts only asynchronous atoms such as types conforming to:
/// ``TaskAtom``, ``ThrowingTaskAtom``, ``AsyncSequenceAtom``, ``PublisherAtom``.
/// It refreshes the value for the given atom and then returns, so the caller can await until
/// the atom completes the update.
Expand Down
2 changes: 1 addition & 1 deletion Sources/Atoms/Context/AtomTestContext.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ public struct AtomTestContext: AtomWatchableContext {

/// Refreshes and then returns the value associated with the given refreshable atom.
///
/// This method only accepts refreshable atoms such as types conforming to:
/// This method accepts only asynchronous atoms such as types conforming to:
/// ``TaskAtom``, ``ThrowingTaskAtom``, ``AsyncSequenceAtom``, ``PublisherAtom``.
/// It refreshes the value for the given atom and then returns, so the caller can await until
/// the atom completes the update.
Expand Down
2 changes: 1 addition & 1 deletion Sources/Atoms/Context/AtomTransactionContext.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ public struct AtomTransactionContext<Coordinator>: AtomWatchableContext {

/// Refreshes and then returns the value associated with the given refreshable atom.
///
/// This method only accepts refreshable atoms such as types conforming to:
/// This method accepts only asynchronous atoms such as types conforming to:
/// ``TaskAtom``, ``ThrowingTaskAtom``, ``AsyncSequenceAtom``, ``PublisherAtom``.
/// It refreshes the value for the given atom and then returns, so the caller can await until
/// the atom completes the update.
Expand Down
2 changes: 1 addition & 1 deletion Sources/Atoms/Context/AtomViewContext.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ public struct AtomViewContext: AtomWatchableContext {

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