From: nsf <no.smile.face@gmail.com>
Date: Tue, 10 Jul 2012 20:44:22 +0000 (+0600)
Subject: torrent: Fix documentation.
X-Git-Tag: v1.0.0~1199^2~13
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=d42799be2c75504e6412ca3e6b22cbe3cb1afbe8;p=btrtrc.git

torrent: Fix documentation.
---

diff --git a/torrent/builder.go b/torrent/builder.go
index fbf9c32d..a32abd29 100644
--- a/torrent/builder.go
+++ b/torrent/builder.go
@@ -258,8 +258,8 @@ func (b *Batch) DefaultName() string {
 // SHA1 hashing. Therefore it will return almost immedately. It returns two
 // channels, the first one is for completion awaiting, the second one is for
 // getting status reports. Status report is a number of bytes hashed, you can
-// get the total amount of bytes by inspecting the appropriate Batch structure
-// field.
+// get the total amount of bytes by inspecting the Batch.TotalSize method return
+// value.
 func (b *Batch) Start(w io.Writer, nworkers int) (<-chan error, <-chan int64) {
 	if nworkers <= 0 {
 		nworkers = 1