Skip to content

Commit b8b0491

Browse files
slight adjustments to make docc rendering of AsyncBufferedByteIterator documentation nicer (#93)
* slight adjustments to make docc rendering of AsyncBufferedByteIterator documentation nicer * Apply suggestions from code review Co-authored-by: Chris Adamson <[email protected]> Co-authored-by: Chris Adamson <[email protected]>
1 parent 4d4022e commit b8b0491

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Sources/AsyncAlgorithms/AsyncBufferedByteIterator.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
//
1010
//===----------------------------------------------------------------------===//
1111

12-
/// AsyncBufferedByteIterator provides a convenient high-performance implementation
13-
/// of a common architecture for AsyncSequences of UInt8s (i.e. byte streams).
12+
/// An `AsyncIterator` that provides a convenient and high-performance implementation
13+
/// of a common architecture for `AsyncSequence` of `UInt8`, otherwise known as byte streams.
1414
///
1515
/// Bytes are read into an internal buffer of `capacity` bytes via the
1616
/// `readFunction`. Invoking `next()` returns bytes from the internal buffer until it's

0 commit comments

Comments
 (0)