From: Matt Joiner <anacrolix@gmail.com>
Date: Sat, 12 Dec 2015 03:00:07 +0000 (+1100)
Subject: Docs
X-Git-Tag: v1.0.0~969
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=83045db3e5d14f3accbb463164df74e4b1d7e19e;p=btrtrc.git

Docs
---

diff --git a/t.go b/t.go
index 5abb9169..ae1e1b87 100644
--- a/t.go
+++ b/t.go
@@ -71,10 +71,14 @@ func (t Torrent) BytesCompleted() int64 {
 	return t.bytesCompleted()
 }
 
+// The subscription emits as (int) the index of pieces as their state changes.
+// A state change is when the PieceState for a piece alters in value.
 func (t Torrent) SubscribePieceStateChanges() *pubsub.Subscription {
 	return t.torrent.pieceStateChanges.Subscribe()
 }
 
+// Returns true if the torrent is currently being seeded. This occurs when the
+// client is willing to upload without wanting anything in return.
 func (t Torrent) Seeding() bool {
 	t.cl.mu.Lock()
 	defer t.cl.mu.Unlock()