Edit README to assume less background knowledge #26
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mainly to clarify that the async generator and async context manager examples are actually two different examples, since Ninpo found this confusing. But then once I started editing I of course changed more than that :-).
Codecov Report
@@ Coverage Diff @@
## master #26 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 7 7
Lines 972 1026 +54
Branches 77 79 +2
=========================================
+ Hits 972 1026 +54
|
sorcio
reviewed
Feb 1, 2019
| `async generators <https://www.python.org/dev/peps/pep-0525/>`__. Just | ||
| like regular generators, they're super convenient; the difference is | ||
| that now you loop over them using ``async for``, and this means you | ||
| can use ``await`` inside them. If you're not doing async programming, |
There was a problem hiding this comment.
I'm worried this might not help the confusion between regular iterators, regular generators, async iterators (as introduced in 3.5 / PEP 492) and async generators (as introduced in 3.6 / PEP 525). This is not the place to go that deep in explanations. But since you're already giving pointers, it might be helpful to clarify that—just like generators are a nice way to write iterators—async generators are super useful to define async iterators.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mainly to clarify that the async generator and async context manager
examples are actually two different examples, since Ninpo found this
confusing. But then once I started editing I of course changed more
than that :-).