]> Sergey Matveev's repositories - btrtrc.git/commitdiff
torrent: Fix documentation.
authornsf <no.smile.face@gmail.com>
Tue, 10 Jul 2012 20:44:22 +0000 (02:44 +0600)
committernsf <no.smile.face@gmail.com>
Tue, 10 Jul 2012 20:44:22 +0000 (02:44 +0600)
torrent/builder.go

index fbf9c32d5dae8eb2624d3982cf99da54a03be6ba..a32abd29c83cd8e0b120884e3cd5a13e673130be 100644 (file)
@@ -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