From: Matt Joiner <anacrolix@gmail.com>
Date: Wed, 20 Apr 2016 10:10:10 +0000 (+1000)
Subject: Improve some docs
X-Git-Tag: v1.0.0~771
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=61acdf6184f1f60870c1a3cb92bb4cb010563097;p=btrtrc.git

Improve some docs
---

diff --git a/t.go b/t.go
index c6d23f05..31515c53 100644
--- a/t.go
+++ b/t.go
@@ -12,9 +12,8 @@ func (t *Torrent) InfoHash() metainfo.Hash {
 	return t.infoHash
 }
 
-// Closed when the info (.Info()) for the torrent has become available. Using
-// features of Torrent that require the info before it is available will have
-// undefined behaviour.
+// Returns a channel that is closed when the info (.Info()) for the torrent
+// has become available.
 func (t *Torrent) GotInfo() <-chan struct{} {
 	return t.gotMetainfo
 }
@@ -102,6 +101,8 @@ func (t *Torrent) Name() string {
 	return t.name()
 }
 
+// The completed length of all the torrent data, in all its files. This is
+// derived from the torrent info, when it is available.
 func (t *Torrent) Length() int64 {
 	select {
 	case <-t.GotInfo():