From 234f9f36c091d215428b43264d8a831847724ac5 Mon Sep 17 00:00:00 2001 From: Nathy-bajo Date: Wed, 11 Sep 2024 23:09:22 +0100 Subject: [PATCH] Add documentation for SyncIoBridge with examples and alternatives --- tokio-util/src/io/sync_bridge.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tokio-util/src/io/sync_bridge.rs b/tokio-util/src/io/sync_bridge.rs index 6ab4b9a0adc..f79e6abb373 100644 --- a/tokio-util/src/io/sync_bridge.rs +++ b/tokio-util/src/io/sync_bridge.rs @@ -72,7 +72,7 @@ use tokio::io::{ /// /// /// When the data doesn't fit into memory, the hashing library will usually -/// provide a hasher that you can repeatedly call `update` on to hash the data +/// provide a `hasher` that you can repeatedly call `update` on to hash the data /// one chunk at the time. For example: /// /// ```rust @@ -201,7 +201,7 @@ use tokio::io::{ /// } /// ``` /// Explanation: This example shows how to asynchronously read data into memory -/// and then parse it as JSON. By avoiding `SyncIoBridge`, the asynchronous runtime +/// and then parse it as `JSON`. By avoiding `SyncIoBridge`, the asynchronous runtime /// remains unblocked, leading to better performance when working with asynchronous /// I/O streams. ///