From 5bb99bb02d6d0ec4d9239fd9bce48a41fb084811 Mon Sep 17 00:00:00 2001
From: John Kugelman <john@kugelman.name>
Date: Tue, 12 Oct 2021 18:27:03 -0400
Subject: [PATCH] Add #[must_use] to Rc::downgrade

---
 library/alloc/src/rc.rs | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/library/alloc/src/rc.rs b/library/alloc/src/rc.rs
index 493cf3117edf6..e9cded6736474 100644
--- a/library/alloc/src/rc.rs
+++ b/library/alloc/src/rc.rs
@@ -41,7 +41,7 @@
 //! use std::rc::Rc;
 //!
 //! let my_rc = Rc::new(());
-//! Rc::downgrade(&my_rc);
+//! let my_weak = Rc::downgrade(&my_rc);
 //! ```
 //!
 //! `Rc<T>`'s implementations of traits like `Clone` may also be called using
@@ -889,6 +889,8 @@ impl<T: ?Sized> Rc<T> {
     ///
     /// let weak_five = Rc::downgrade(&five);
     /// ```
+    #[must_use = "this returns a new `Weak` pointer, \
+                  without modifying the original `Rc`"]
     #[stable(feature = "rc_weak", since = "1.4.0")]
     pub fn downgrade(this: &Self) -> Weak<T> {
         this.inner().inc_weak();