Skip to content

Commit 2e51ac1

Browse files
phauslerparkera
andauthored
Apply suggestions from code review for README
Co-authored-by: Tony Parker <[email protected]>
1 parent fd2812d commit 2e51ac1

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This package has three main goals:
1414

1515
The foundation for AsyncAlgorithms was included in Swift 5.5 from [AsyncSequence](https://github.com/apple/swift-evolution/blob/main/proposals/0298-asyncsequence.md). Swift 5.5 also brings the ability to use a natural `for/in` loop with `await` to process the values in an `AsyncSequence` and `Sequence`-equivalent API like `map` and `filter`. Structured concurrency allows us to write code where intermediate state is simply a local variable, `try` can be used directly on functions that `throw`, and generally treat the logic for asynchronous code similar to that of synchronous code.
1616

17-
This package will provide a home for these APIs. Development and API design will take place on [GitHub](https://github.com/apple/swift-async-algorithms) and the [Swift Forums](https://forums.swift.org/c/related-projects/).
17+
This package is the home for these APIs. Development and API design take place on [GitHub](https://github.com/apple/swift-async-algorithms) and the [Swift Forums](https://forums.swift.org/c/related-projects/).
1818

1919
## Contents
2020

@@ -86,7 +86,7 @@ Finally, add `import AsyncAlgorithms` to your source code.
8686

8787
## Getting Started
8888

89-
⚠️ Please note that the swift-async-algorithms currently requires a recent [Swift Trunk Development toolchain](https://www.swift.org/download/#trunk-development-main). More information on how to use [custom toolchains with Xcode can be viewed here](https://developer.apple.com/library/archive/documentation/ToolsLanguages/Conceptual/Xcode_Overview/AlternativeToolchains.html).
89+
⚠️ Please note that this package currently requires a recent [Swift Trunk Development toolchain](https://www.swift.org/download/#trunk-development-main). More information on how to use custom toolchains with Xcode can be viewed [here](https://developer.apple.com/library/archive/documentation/ToolsLanguages/Conceptual/Xcode_Overview/AlternativeToolchains.html).
9090

9191
### Building/Testing Using Xcode on macOS
9292

@@ -96,7 +96,7 @@ Finally, add `import AsyncAlgorithms` to your source code.
9696
4. Open the `swift-async-algorithms` package directory in Xcode
9797
5. Build or Test in Xcode as normal
9898

99-
⚠️ Warning: `swift test` does not currently work properly with custom toolchains for this package.
99+
⚠️ Note: `swift test` does not currently work properly with custom toolchains for this package.
100100

101101
### Building/Testing on Linux
102102

0 commit comments

Comments
 (0)