From 6120688146c11506e7a1e836ec8a2492eceb211c Mon Sep 17 00:00:00 2001
From: codesoap <codesoap@mailbox.org>
Date: Wed, 31 Jan 2024 18:31:56 +0000
Subject: [PATCH] container/heap: remove confusing claim of memory leak

The term "memory leak" was misused here, as the memory is still referenced
by the slice.

Fixes #65403

Change-Id: Id102419d4c798fb2a4ec8be86be9ec9b5cdd98e6
GitHub-Last-Rev: 3febcd0ba4ab5897bef8f2d7ded594ef09932771
GitHub-Pull-Request: golang/go#65404
Reviewed-on: https://go-review.googlesource.com/c/go/+/559775
Auto-Submit: Keith Randall <khr@golang.org>
Reviewed-by: Mauri de Souza Meneguzzo <mauri870@gmail.com>
Reviewed-by: Keith Randall <khr@golang.org>
Reviewed-by: Robert Griesemer <gri@google.com>
Reviewed-by: Keith Randall <khr@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
---
 src/container/heap/example_pq_test.go | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/container/heap/example_pq_test.go b/src/container/heap/example_pq_test.go
index 4511b6c33e..26331f312d 100644
--- a/src/container/heap/example_pq_test.go
+++ b/src/container/heap/example_pq_test.go
@@ -45,7 +45,7 @@ func (pq *PriorityQueue) Pop() any {
 	old := *pq
 	n := len(old)
 	item := old[n-1]
-	old[n-1] = nil  // avoid memory leak
+	old[n-1] = nil  // don't stop the GC from reclaiming the item eventually
 	item.index = -1 // for safety
 	*pq = old[0 : n-1]
 	return item