[wip] Edits for async chapter #3965
Merged
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
- Rewrite the end of Ch. 16 to account for the fact that it no longer transitions to the OOP/etc. chapter. - Add a summary to the end of Ch. 17, pulling over a bunch of the text that was previously in the end of Ch. 16. - Rewrite the introduction to Ch. 17, for a more seamless shift from Ch. 16 and contextualizing async in the broader software ecosystem.
Revise the text itself, of course; but also fold together Listings 04 and 05, which also lets us expand Listing 03 into two listings (which I did not do previously because I knew this kind of thing would come up later!).
- The usual kinds of clarifications, cleaning up redundancies, etc.
- Fold together listings:
- 8 and 9 → 8
- 10, 11, 12 → 9
- 13 → 10
- 15 → 11
- 16 → 12
- Tweak the durations used for the listings throughout this section,
including making the durations *differ* between the two sending blocks
in the final example.
Update the listings, eliminating them where possible and adding notes about manual regeneration as necessary. Also clean up a *lot* of issues with wording, phrasing, etc.!
That is, don't remove the square brackets in these cases. I don't know how I lived like this.
- Made a bunch of structural changes, including removing an entire unhelpful aside with an example that actually just confused things, and I *think* it is much more technically accurate *and* much easier to follow. - Updated the listings referenced within it for their new numberings, including deleting one per the above.
Eliminate `trpl::timeout` entirely. Instead, just build the `timeout` directly (as the rest of the section already did). Restructure the listings as well, eliminating duplication and extraneous bits.
A number of examples *already* do not work correctly, and the inbound async chapter requires Rust 2021.
15 tasks
Use Rust 2021 Edition for mdBook
- Flip the order, so that the semi-practical introduction comes first. - Merge several of the listings together. - The usual polishing and iterating on the text.
|
Merged into #3909. An |
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.
We have now effectively “frozen” the
only-new-asyncbranch to allow some early readers to take a look at it. Going forward, I will be landing a bunch of iterative work on this branch, including:rewriting the transition out of ch. 16.
updating references throughout the rest of the book as makes sense.
editing and revising the new material in the chapter (classic red-pen-style!)
Once we have gotten that first round of feedback, I will also integrate that here, and then we can merge this into the
only-new-asyncbranch.