From: Matt Joiner <anacrolix@gmail.com>
Date: Sat, 16 Jan 2016 14:49:34 +0000 (+1100)
Subject: Resurrect some comments on Torrent methods
X-Git-Tag: v1.0.0~940
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=8bbfcfcaa4b2fba8ab67f836718af2f85d16aaed;p=btrtrc.git

Resurrect some comments on Torrent methods
---

diff --git a/t.go b/t.go
index 8f792bf9..23085d1b 100644
--- a/t.go
+++ b/t.go
@@ -28,7 +28,7 @@ func (t Torrent) GotInfo() <-chan struct{} {
 	return t.torrent.gotMetainfo
 }
 
-// Returns the metainfo, or nil if it's not yet available.
+// Returns the metainfo info dictionary, or nil if it's not yet available.
 func (t Torrent) Info() *metainfo.Info {
 	return t.torrent.Info
 }
@@ -53,6 +53,8 @@ func (t Torrent) PieceStateRuns() []PieceStateRun {
 	return t.torrent.pieceStateRuns()
 }
 
+// The number of pieces in the torrent. This requires that the info has been
+// obtained first.
 func (t Torrent) NumPieces() int {
 	return t.torrent.numPieces()
 }
@@ -93,6 +95,8 @@ func (t Torrent) SetDisplayName(dn string) {
 	t.torrent.setDisplayName(dn)
 }
 
+// The current working name for the torrent. Either the name in the info dict,
+// or a display name given such as by the dn value in a magnet link, or "".
 func (t Torrent) Name() string {
 	t.cl.mu.Lock()
 	defer t.cl.mu.Unlock()