Clean-up Blocking operations Docs #7834
Conversation
docs/reference/core/zio/zio.md
Outdated
| ZIO has a separate **blocking thread pool** specially designed for **Blocking I/O** and, also **CPU Work** workloads. We should run blocking workloads on this thread pool by using `ZIO.blocking` or `ZIO.attemptBlocking*` constructors to prevent interfering with the primary thread pool. | ||
|
|
||
| :::note | ||
| ZIO has an auto-blocking mechanism that detects blocking operations and runs them on a separate blocking thread pool. However, it is recommended to import blocking side effects. |
There was a problem hiding this comment.
"side effect" terminology is deprecated and should be removed, here and elsewhere.
There was a problem hiding this comment.
@jdegoes Can you elaborate more on this?
There was a problem hiding this comment.
@khajavi The concept of "side effects" comes from functional programming and does not make sense to developers coming from other backgrounds. We have taken significant steps to make this concept not relevant. For example ZIO.succeed accepts a by name parameter so you use ZIO.succeed whether the body is side effecting or not. We are trying to "dissolve" the concept of side effects.
So I would rewrite this along the lines of:
"ZIO has an auto-blocking mechanism that detects blocking operations and runs them on a separate blocking thread pool. However, if you know that some code is blocking you can use the ZIO.blocking constructor to give a "hint" of this to the ZIO runtime."
Also fixes #7653