debug/gocore: document that a gocore.Object is reachable
Unreachable objects don't get an Object.
Change-Id: Ia9c122d9619d186c02345cb9ed5a857ac599b6b8
Reviewed-on: https://go-review.googlesource.com/98955
Reviewed-by: Peter Weinberger <pjw@google.com>
diff --git a/gocore/object.go b/gocore/object.go
index 6990e33..f81c40c 100644
--- a/gocore/object.go
+++ b/gocore/object.go
@@ -11,7 +11,8 @@
"golang.org/x/debug/core"
)
-// An Object represents a single object in the Go heap.
+// An Object represents a single reachable object in the Go heap.
+// Unreachable (garbage) objects are not represented as Objects.
type Object core.Address
// markObjects finds all the live objects in the heap and marks them
