From 1fb00335df72fc3a05cd13a2bd5013f362d21177 Mon Sep 17 00:00:00 2001
From: Sean Linsley <code@seanlinsley.com>
Date: Mon, 16 Oct 2023 12:41:43 -0500
Subject: [PATCH] Improve rewind documentation

---
 library/std/src/io/mod.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/library/std/src/io/mod.rs b/library/std/src/io/mod.rs
index c0a729481121a..b7b6a9a24c9b9 100644
--- a/library/std/src/io/mod.rs
+++ b/library/std/src/io/mod.rs
@@ -556,6 +556,10 @@ where
 /// therefore, using something that implements [`BufRead`], such as
 /// [`BufReader`], will be more efficient.
 ///
+/// Repeated calls to the reader use the same cursor, so for example
+/// calling `read_to_end` twice on a [`File`] will only return the file's
+/// contents once. It's recommended to first call `rewind()` in that case.
+///
 /// # Examples
 ///
 /// [`File`]s implement `Read`: