Skip to content

Commit dc804fb

Browse files
committed
README: clarify
Co-author: laurylopes <[email protected]>
1 parent 7cd6f63 commit dc804fb

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,11 @@ Iterate over a `Stream[T]` just as you would over any other `Iterable[T]` (or `A
109109
</details>
110110

111111

112-
# example: Extract-Transform-Load
112+
# Showcase: Extract-Transform-Load
113113

114-
Let's take an example showcasing most of the `Stream`'s operations: Below is a pipeline that extracts the 67 quadruped Pokémon from the first three generations using [PokéAPI](https://pokeapi.co/) and loads them into a CSV:
114+
Let's take an example showcasing most of the `Stream`'s operations:
115+
116+
This script extracts the 67 quadruped Pokémon from the first three generations using [PokéAPI](https://pokeapi.co/) and loads them into a CSV:
115117

116118
```python
117119
import csv
@@ -217,7 +219,7 @@ asyncio.run(main())
217219
A dozen expressive lazy operations and that's it.
218220

219221
> [!NOTE]
220-
> **`async` counterparts:** The operations accepting a function as an argument have an `async` counterpart operation (same name but with an "`a`" prefix), which has the same signature but accepts `async` functions instead. Both regular and `async` operations can be mixed on the same `Stream`, and it can then be consumed as regular `Iterable` or as `AsyncIterable`.
222+
> **`async` twin operations:** Each operation that takes a function also has an async version (same name with an `a` prefix) that accepts `async` functions. You can mix both types of operations on the same `Stream`, which can be used as either an `Iterable` or an `AsyncIterable`.
221223
222224
## `.map`/`.amap`
223225

0 commit comments

Comments
 (0)