From 61acdf6184f1f60870c1a3cb92bb4cb010563097 Mon Sep 17 00:00:00 2001 From: Matt Joiner Date: Wed, 20 Apr 2016 20:10:10 +1000 Subject: [PATCH] Improve some docs --- t.go | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) 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():