Skip to content

Commit ba30f20

Browse files
FranzBuschFranzBusch
committed
Documentation
1 parent d5b49aa commit ba30f20

File tree

11 files changed

+20
-16
lines changed

11 files changed

+20
-16
lines changed

‎Sources/AsyncAlgorithms/AsyncAlgorithms.docc/Guides/BufferedBytes.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# AsyncBufferedByteIterator
22

3+
Provides a highly efficient iterator useful for iterating byte sequences derived from asynchronous read functions.
4+
35
[[Source](https://github.com/apple/swift-async-algorithms/blob/main/Sources/AsyncAlgorithms/AsyncBufferedByteIterator.swift) |
46
[Tests](https://github.com/apple/swift-async-algorithms/blob/main/Tests/AsyncAlgorithmsTests/TestBufferedByteIterator.swift)]
57

6-
Provides a highly efficient iterator useful for iterating byte sequences derived from asynchronous read functions.
7-
88
This type provides infrastructure for creating `AsyncSequence` types with an `Element` of `UInt8` backed by file descriptors or similar read sources.
99

1010
```swift

‎Sources/AsyncAlgorithms/AsyncAlgorithms.docc/Guides/Chain.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Chain
22

3+
Chains two or more asynchronous sequences together sequentially.
4+
35
[[Source](https://github.com/apple/swift-async-algorithms/blob/main/Sources/AsyncAlgorithms/AsyncChain2Sequence.swift), [Source](https://github.com/apple/swift-async-algorithms/blob/main/Sources/AsyncAlgorithms/AsyncChain3Sequence.swift) |
46
[Tests](https://github.com/apple/swift-async-algorithms/blob/main/Tests/AsyncAlgorithmsTests/TestChain.swift)]
57

‎Sources/AsyncAlgorithms/AsyncAlgorithms.docc/Guides/CombineLatest.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Combine Latest
22

3+
Combines the latest values produced from two or more asynchronous sequences into an asynchronous sequence of tuples.
4+
35
[[Source](https://github.com/apple/swift-async-algorithms/blob/main/Sources/AsyncAlgorithms/CombineLatest/AsyncCombineLatest2Sequence.swift), [Source](https://github.com/apple/swift-async-algorithms/blob/main/Sources/AsyncAlgorithms/CombineLatest/AsyncCombineLatest3Sequence.swift) |
46
[Tests](https://github.com/apple/swift-async-algorithms/blob/main/Tests/AsyncAlgorithmsTests/TestCombineLatest.swift)]
57

6-
Combines the latest values produced from two or more asynchronous sequences into an asynchronous sequence of tuples.
7-
88
```swift
99
let appleFeed = URL("http://www.example.com/ticker?symbol=AAPL").lines
1010
let nasdaqFeed = URL("http://www.example.com/ticker?symbol=^IXIC").lines

‎Sources/AsyncAlgorithms/AsyncAlgorithms.docc/Guides/Effects.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# Effects
2+
3+
Lists the effects of all async algorithms.
4+
15
| Type | Throws | Sendability |
26
|-----------------------------------------------------|--------------|-------------|
37
| `AsyncAdjacentPairsSequence` | rethrows | Conditional |

‎Sources/AsyncAlgorithms/AsyncAlgorithms.docc/Guides/Intersperse.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Intersperse
22

3+
Places a given value in between each element of the asynchronous sequence.
4+
35
[[Source](https://github.com/apple/swift-async-algorithms/blob/main/Sources/AsyncAlgorithms/AsyncInterspersedSequence.swift) |
46
[Tests](https://github.com/apple/swift-async-algorithms/blob/main/Tests/AsyncAlgorithmsTests/TestInterspersed.swift)]
57

6-
Places a given value in between each element of the asynchronous sequence.
7-
88
```swift
99
let numbers = [1, 2, 3].async.interspersed(with: 0)
1010
for await number in numbers {

‎Sources/AsyncAlgorithms/AsyncAlgorithms.docc/Guides/Lazy.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# AsyncSyncSequence
22

3+
v
4+
35
[[Source](https://github.com/apple/swift-async-algorithms/blob/main/Sources/AsyncAlgorithms/AsyncSyncSequence.swift) |
46
[Tests](https://github.com/apple/swift-async-algorithms/blob/main/Tests/AsyncAlgorithmsTests/TestLazy.swift)]
57

6-
Converts a non-asynchronous sequence into an asynchronous one.
7-
88
This operation is available for all `Sequence` types.
99

1010
```swift

‎Sources/AsyncAlgorithms/AsyncAlgorithms.docc/Guides/Merge.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Merge
22

3+
Merges two or more asynchronous sequences sharing the same element type into one singular asynchronous sequence.
4+
35
[[Source](https://github.com/apple/swift-async-algorithms/blob/main/Sources/AsyncAlgorithms/Merge/AsyncMerge2Sequence.swift), [Source](https://github.com/apple/swift-async-algorithms/blob/main/Sources/AsyncAlgorithms/Merge/AsyncMerge3Sequence.swift) |
46
[Tests](https://github.com/apple/swift-async-algorithms/blob/main/Tests/AsyncAlgorithmsTests/TestMerge.swift)]
57

6-
Merges two or more asynchronous sequences sharing the same element type into one singular asynchronous sequence.
7-
88
```swift
99
let appleFeed = URL(string: "http://www.example.com/ticker?symbol=AAPL")!.lines.map { "AAPL: " + $0 }
1010
let nasdaqFeed = URL(string:"http://www.example.com/ticker?symbol=^IXIC")!.lines.map { "^IXIC: " + $0 }

‎Sources/AsyncAlgorithms/AsyncAlgorithms.docc/Guides/Zip.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Zip
22

3+
Combines the latest values produced from two or more asynchronous sequences into an asynchronous sequence of tuples.
4+
35
[[Source](https://github.com/apple/swift-async-algorithms/blob/main/Sources/AsyncAlgorithms/Zip/AsyncZip2Sequence.swift), [Source](https://github.com/apple/swift-async-algorithms/blob/main/Sources/AsyncAlgorithms/Zip/AsyncZip3Sequence.swift) |
46
[Tests](https://github.com/apple/swift-async-algorithms/blob/main/Tests/AsyncAlgorithmsTests/TestZip.swift)]
57

6-
Combines the latest values produced from two or more asynchronous sequences into an asynchronous sequence of tuples.
7-
88
```swift
99
let appleFeed = URL(string: "http://www.example.com/ticker?symbol=AAPL")!.lines
1010
let nasdaqFeed = URL(string: "http://www.example.com/ticker?symbol=^IXIC")!.lines

‎Sources/AsyncAlgorithms/Dictionary.swift‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ extension Dictionary {
2020
///
2121
/// - Parameter keysAndValues: An asynchronous sequence of key-value pairs to use for
2222
/// the new dictionary. Every key in `keysAndValues` must be unique.
23-
/// - Returns: A new dictionary initialized with the elements of
24-
/// `keysAndValues`.
2523
/// - Precondition: The sequence must not have duplicate keys.
2624
@inlinable
2725
public init<S: AsyncSequence>(uniqueKeysWithValues keysAndValues: S) async rethrows

‎Sources/AsyncAlgorithms/Merge/AsyncMerge2Sequence.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ where
2525
return AsyncMerge2Sequence(base1, base2)
2626
}
2727

28-
/// An ``Swift/AsyncSequence`` that takes two upstream ``Swift/AsyncSequence``s and combines their elements.
28+
/// An `AsyncSequence` that takes two upstream `AsyncSequence`s and combines their elements.
2929
public struct AsyncMerge2Sequence<
3030
Base1: AsyncSequence,
3131
Base2: AsyncSequence

0 commit comments

Comments
 (0)