From 20728894c9388cebe7af91f11c1e0ddd59eb689b Mon Sep 17 00:00:00 2001
From: Bart Jacobs <bart.jacobs@cs.kuleuven.be>
Date: Wed, 29 Jan 2025 08:35:29 +0100
Subject: [PATCH] btree/node.rs: pop_internal_level: does not invalidate other
 handles

---
 alloc/src/collections/btree/node.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/alloc/src/collections/btree/node.rs b/alloc/src/collections/btree/node.rs
index 2525f5856cd21..37f784a322cad 100644
--- a/alloc/src/collections/btree/node.rs
+++ b/alloc/src/collections/btree/node.rs
@@ -600,6 +600,9 @@ impl<K, V> NodeRef<marker::Owned, K, V, marker::LeafOrInternal> {
     /// no cleanup is done on any of the keys, values and other children.
     /// This decreases the height by 1 and is the opposite of `push_internal_level`.
     ///
+    /// Does not invalidate any handles or references pointing into the subtree
+    /// rooted at the first child of `self`.
+    ///
     /// Panics if there is no internal level, i.e., if the root node is a leaf.
     pub(super) fn pop_internal_level<A: Allocator + Clone>(&mut self, alloc: A) {
         assert!(self.height > 0);