Improve Torrent.DownloadPieces documentation

Was mentioned in Gitter.

diff --git a/t.go b/t.go
index ee78b1839277fe1b4d614d8846d58971c6ab659d..516a074af6631bad8757cabc9157ee0984379554 100644 (file)
--- a/t.go
+++ b/t.go
@@ -149,6 +149,9 @@ func (t *Torrent) deleteReader(r *reader) {
        t.readersChanged()
 }
 
+// Raise the priorities of pieces in the range [begin, end) to at least Normal
+// priority. Piece indexes are not the same as bytes. Requires that the info
+// has been obtained, see Torrent.Info and Torrent.GotInfo.
 func (t *Torrent) DownloadPieces(begin, end int) {
        t.cl.mu.Lock()
        defer t.cl.mu.Unlock()