From ee149e41039d835599701a386aa85571d23ee543 Mon Sep 17 00:00:00 2001
From: Nora Widdecke <nora@sequoia-pgp.org>
Date: Thu, 5 Nov 2020 17:28:29 +0100
Subject: buffered_reader: Explain fmt::Display use.

---
 buffered-reader/src/lib.rs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'buffered-reader')

diff --git a/buffered-reader/src/lib.rs b/buffered-reader/src/lib.rs
index 308187ea..83f6da1c 100644
--- a/buffered-reader/src/lib.rs
+++ b/buffered-reader/src/lib.rs
@@ -816,8 +816,9 @@ pub trait BufferedReader<C> : io::Read + fmt::Debug + fmt::Display
         Ok(at_least_one_byte)
     }
 
-    /// Dump
     /// A helpful debugging aid to pretty print a Buffered Reader stack.
+    ///
+    /// Uses the Buffered Readers' `fmt::Display` implementations.
     fn dump(&self) where Self: std::marker::Sized {
         let mut i = 1;
         let mut reader: Option<&dyn BufferedReader<C>> = Some(self);
-- 
cgit v1.2.3