From 890380c018c2396d1242e957b9d7db126f31488c Mon Sep 17 00:00:00 2001
From: Martin Fischer <martin@push-f.com>
Date: Sun, 3 Sep 2023 13:36:14 +0200
Subject: docs: document that BufReadReader reads UTF-8

---
 src/reader.rs | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

(limited to 'src')

diff --git a/src/reader.rs b/src/reader.rs
index b6e0905..b08821f 100644
--- a/src/reader.rs
+++ b/src/reader.rs
@@ -112,8 +112,7 @@ impl<'a> IntoReader<'a> for &'a String {
     }
 }
 
-/// A [`BufReadReader`] can be used to construct a tokenizer from any type that implements
-/// `BufRead`.
+/// A [`BufRead`]-based [`Reader`] implementation that attempts to read UTF-8.
 pub struct BufReadReader<R: BufRead> {
     line: String,
     line_pos: usize,
-- 
cgit v1.2.3