object/store: Clarify quarantine docs

1 files changed, 5 insertions, 1 deletions

diff --git a/object/store/quarantine.go b/object/store/quarantine.go
index 7f538f43..a9ba4f55 100644
--- a/object/store/quarantine.go
+++ b/object/store/quarantine.go
@@ -2,12 +2,16 @@ package objectstore
 
 // Quarantine is one quarantined write. It is intended to be embedded.
 type Quarantine interface {
-	// Reader returns the objects written into this quarantine.
+	// Reader exposes the objects written into this quarantine.
 	Reader
 
 	// Promote publishes quarantined writes into their final destination.
+	//
+	// Promote invalidates the receiver.
 	Promote() error
 
 	// Discard abandons quarantined writes.
+	//
+	// Discard invalidates the receiver.
 	Discard() error
 }