]> Sergey Matveev's repositories - btrtrc.git/commitdiff
Improve some docs
authorMatt Joiner <anacrolix@gmail.com>
Wed, 20 Apr 2016 10:10:10 +0000 (20:10 +1000)
committerMatt Joiner <anacrolix@gmail.com>
Wed, 20 Apr 2016 10:10:10 +0000 (20:10 +1000)
t.go

diff --git a/t.go b/t.go
index c6d23f059f05255f629ebeac44aa8d0f748dda01..31515c53090235120c7348cab5a7e1d8be6a1024 100644 (file)
--- 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():