Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modifications to the async section #556

Merged
merged 3 commits into from
Apr 6, 2023

Conversation

djmitche
Copy link
Collaborator

@djmitche djmitche commented Apr 5, 2023

This is a pretty heavy edit to issue181 branch, in response to comments on #496.

  • Remove the "Daemon" slide, as it largely duplicates the "Tasks" slide. The introduction to the "Control Flow" section mentions tasks as a kind of control flow.

  • Reorganize the structure in SUMMARY.md to correspond to the directory structure.

  • Simplify the "Pin" and "Blocking the Executor" slides with steps in the speaker notes to demonstrate / fix the issues.

  • Rename "join_all" to "Join".

  • Simplify some code samples to shorten them, and to print output rather than asserting.

  • Clarify speaker notes and include more "Try.." suggestions.

  • Be consistent about where async blocks are introduced (in the "Tasks" slide).

  • Explain join and select in prose.

  • Fix formatting of section-header slides.

* Remove the "Daemon" slide, as it largely duplicates the "Tasks" slide.
  The introduction to the "Control Flow" section mentions tasks as a
  kind of control flow.

* Reorganize the structure in SUMMARY.md to correspond to the directory
  structure.

* Simplify the "Pin" and "Blocking the Executor" slides with steps in
  the speaker notes to demonstrate / fix the issues.

* Rename "join_all" to "Join".

* Simplify some code samples to shorten them, and to print output rather
  than asserting.

* Clarify speaker notes and include more "Try.." suggestions.

* Be consistent about where `async` blocks are introduced (in the
  "Tasks" slide).

* Explain `join` and `select` in prose.

* Fix formatting of section-header slides.
@djmitche djmitche requested review from rbehjati and sakex April 5, 2023 21:50
src/async/control-flow/daemon.md Outdated Show resolved Hide resolved
src/async/control-flow/join_all.md Show resolved Hide resolved
@sakex
Copy link
Collaborator

sakex commented Apr 5, 2023

Thanks for simplifying the examples, it looks much better

Copy link
Collaborator

@rbehjati rbehjati left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very nice. Thanks. I've left a number of, mostly minor, and copy-edit comments.

src/async/control-flow/join_all.md Show resolved Hide resolved
src/async/control-flow/select.md Outdated Show resolved Hide resolved
src/async/tasks.md Outdated Show resolved Hide resolved
src/async/pitfalls/blocking-executor.md Outdated Show resolved Hide resolved
src/async/channels.md Outdated Show resolved Hide resolved
src/async/pitfalls/blocking-executor.md Outdated Show resolved Hide resolved
src/async/pitfalls/pin.md Outdated Show resolved Hide resolved
src/async/pitfalls/pin.md Outdated Show resolved Hide resolved
src/async/pitfalls/pin.md Outdated Show resolved Hide resolved
src/async/pitfalls/pin.md Outdated Show resolved Hide resolved
@rbehjati rbehjati mentioned this pull request Apr 6, 2023
@djmitche djmitche merged commit 2db1f14 into google:issue181 Apr 6, 2023
djmitche added a commit that referenced this pull request Apr 14, 2023
* beginning of an Async section

* address review comments

* Add futures page (#497)

NOTE: `mdbook test` does not allow code samples to reference other crates, so
they must be marked as `compile_fail`; see #175.

* Add Runtimes & Tasks (#522)

These concepts are closely related, and there's not much else to know
about runtimes other than "they exist".

This removes the bit about futures being "inert" because it doesn't
really lead anywhere.

* Async chapter (#524)

* Add async channels chapter

* Async control flow

* Async pitfalls

* Separate in multiple chapters + add daemon section

* Merge reentering threads in blocking-executor

* async_trait

* Async fixes (#546)

* Async: some ideas for simplifying the content (#550)

* Simplify the async-await slide
* Shorten futures and move it up
* Add a page on Tokio

* Modifications to the async section (#556)

* Modifications to the async section

* Remove the "Daemon" slide, as it largely duplicates the "Tasks" slide.
  The introduction to the "Control Flow" section mentions tasks as a
  kind of control flow.

* Reorganize the structure in SUMMARY.md to correspond to the directory
  structure.

* Simplify the "Pin" and "Blocking the Executor" slides with steps in
  the speaker notes to demonstrate / fix the issues.

* Rename "join_all" to "Join".

* Simplify some code samples to shorten them, and to print output rather
  than asserting.

* Clarify speaker notes and include more "Try.." suggestions.

* Be consistent about where `async` blocks are introduced (in the
  "Tasks" slide).

* Explain `join` and `select` in prose.

* Fix formatting of section-header slides.

* Add a note on async trait (#558)

---------

Co-authored-by: sakex <alexandre@senges.ch>
Co-authored-by: rbehjati <razieh@google.com>
NoahDragon pushed a commit to wnghl/comprehensive-rust that referenced this pull request Jul 19, 2023
* beginning of an Async section

* address review comments

* Add futures page (google#497)

NOTE: `mdbook test` does not allow code samples to reference other crates, so
they must be marked as `compile_fail`; see google#175.

* Add Runtimes & Tasks (google#522)

These concepts are closely related, and there's not much else to know
about runtimes other than "they exist".

This removes the bit about futures being "inert" because it doesn't
really lead anywhere.

* Async chapter (google#524)

* Add async channels chapter

* Async control flow

* Async pitfalls

* Separate in multiple chapters + add daemon section

* Merge reentering threads in blocking-executor

* async_trait

* Async fixes (google#546)

* Async: some ideas for simplifying the content (google#550)

* Simplify the async-await slide
* Shorten futures and move it up
* Add a page on Tokio

* Modifications to the async section (google#556)

* Modifications to the async section

* Remove the "Daemon" slide, as it largely duplicates the "Tasks" slide.
  The introduction to the "Control Flow" section mentions tasks as a
  kind of control flow.

* Reorganize the structure in SUMMARY.md to correspond to the directory
  structure.

* Simplify the "Pin" and "Blocking the Executor" slides with steps in
  the speaker notes to demonstrate / fix the issues.

* Rename "join_all" to "Join".

* Simplify some code samples to shorten them, and to print output rather
  than asserting.

* Clarify speaker notes and include more "Try.." suggestions.

* Be consistent about where `async` blocks are introduced (in the
  "Tasks" slide).

* Explain `join` and `select` in prose.

* Fix formatting of section-header slides.

* Add a note on async trait (google#558)

---------

Co-authored-by: sakex <alexandre@senges.ch>
Co-authored-by: rbehjati <razieh@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants