diff --git a/packages/yew/src/platform/fmt/buffer.rs b/packages/yew/src/platform/fmt/buffer.rs index c929db89ae9..28b88c8396a 100644 --- a/packages/yew/src/platform/fmt/buffer.rs +++ b/packages/yew/src/platform/fmt/buffer.rs @@ -77,9 +77,9 @@ impl Write for Inner { } } -/// An asynchronous String BufWriter. +/// An asynchronous [`String`] writer. /// -/// This type implements [`fmt::Write`] and can be. +/// This type implements [`fmt::Write`] and can be used with [`write!`] and [`writeln!`]. pub(crate) struct BufWriter { inner: Rc>, } @@ -144,7 +144,7 @@ impl Drop for BufWriter { } } -/// An asynchronous String Stream. +/// An asynchronous [`String`] reader. pub(crate) struct BufReader { inner: Rc>, } diff --git a/packages/yew/src/platform/fmt/mod.rs b/packages/yew/src/platform/fmt/mod.rs index bd68464d407..9bba8a61213 100644 --- a/packages/yew/src/platform/fmt/mod.rs +++ b/packages/yew/src/platform/fmt/mod.rs @@ -11,7 +11,7 @@ mod buffer; pub(crate) use buffer::{buffer, BufReader, BufWriter}; -/// A buffered asynchronous string Stream. +/// A buffered asynchronous [`String`] [`Stream`]. /// /// A BufStream combines a BufWriter - BufReader pair and a resolving future that writes to the /// buffer and polls the future alongside the buffer.