Update documentation.

yewstack · Sep 4, 2022 · f491d6c · f491d6c
1 parent 67348d3
commit f491d6c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git 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<UnsafeCell<Inner>>,
 }
@@ -144,7 +144,7 @@ impl Drop for BufWriter {
     }
 }
 
-/// An asynchronous String Stream.
+/// An asynchronous [`String`] reader.
 pub(crate) struct BufReader {
     inner: Rc<UnsafeCell<Inner>>,
 }

diff --git 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.