From: Matt Joiner <anacrolix@gmail.com>
Date: Mon, 18 Apr 2016 11:52:30 +0000 (+1000)
Subject: Improve doc on Torrent.Drop
X-Git-Tag: v1.0.0~775
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=dcec4f3dceaac094b241e256e48bc44ed8e439c5;p=btrtrc.git

Improve doc on Torrent.Drop

https://github.com/anacrolix/torrent/issues/73
---

diff --git a/t.go b/t.go
index e207a09a..c6d23f05 100644
--- a/t.go
+++ b/t.go
@@ -56,7 +56,9 @@ func (t *Torrent) NumPieces() int {
 	return t.numPieces()
 }
 
-// Drop the torrent from the client, and close it.
+// Drop the torrent from the client, and close it. It's always safe to do
+// this. No data corruption can, or should occur to either the torrent's data,
+// or connected peers.
 func (t *Torrent) Drop() {
 	t.cl.mu.Lock()
 	t.cl.dropTorrent(t.infoHash)