Skip to content

Documentation: Correct placement of doc comments in AsyncSequence (for release branch) #37687

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 5 commits into from
Jun 2, 2021
Merged

Documentation: Correct placement of doc comments in AsyncSequence (for release branch) #37687

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
122d079
Correct placement of doc comments in AsyncSequence
May 27, 2021
e2f4218
Correct indentation.
May 27, 2021
fa72b30
Better abstract for associatedtype AsyncIterator
May 27, 2021
cd42291
Remove symbol from Actor abstract.
May 27, 2021
6da94ec
Restore code voice in Actor discussion.
May 28, 2021
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
6 changes: 3 additions & 3 deletions stdlib/public/Concurrency/Actor.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import Swift

/// Common protocol to which all actors conform.
///
/// The \c Actor protocol generalizes over all actor types. Actor types
/// The `Actor` protocol generalizes over all actor types. Actor types
/// implicitly conform to this protocol.
@available(SwiftStdlib 5.5, *)
public protocol Actor: AnyObject, Sendable {
Expand Down Expand Up @@ -52,8 +52,8 @@ public func _defaultActorDestroy(_ actor: AnyObject)
@usableFromInline
internal func _enqueueOnMain(_ job: UnownedJob)

/// A singleton actor whose executor is equivalent to
/// \c DispatchQueue.main, which is the main dispatch queue.
/// A singleton actor whose executor is equivalent to the main
/// dispatch queue.
@available(SwiftStdlib 5.5, *)
@globalActor public final actor MainActor: SerialExecutor {
public static let shared = MainActor()
Expand Down
6 changes: 4 additions & 2 deletions stdlib/public/Concurrency/AsyncSequence.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,16 @@ import Swift
@available(SwiftStdlib 5.5, *)
@rethrows
public protocol AsyncSequence {
/// The type of element produced by this asynchronous sequence.
/// The type of asynchronous iterator that produces elements of this
/// asynchronous sequence.
associatedtype AsyncIterator: AsyncIteratorProtocol where AsyncIterator.Element == Element
/// The type of element produced by this asynchronous sequence.
associatedtype Element
/// Creates the asynchronous iterator that produces elements of this
/// asynchronous sequence.
///
/// - Returns: An instance of the `AsyncIterator` type used to produce
/// elements of the asynchronous sequence.
associatedtype Element
__consuming func makeAsyncIterator() -> AsyncIterator
}

Expand Down