Add batch size and delay docs

This commit adds documentation for batch size and delay to the
DB.Batch() call. Previously there was no reference to these properties
from the Batch() call so it was nearly impossible for anyone to
know to adjust these settings.

Thanks to Kelly Sommers for bringing the doc issue to my attention.
master
Ben Johnson 2015-06-10 10:59:56 -06:00
parent 5eb31d5821
commit 696f3a3ada
1 changed files with 3 additions and 0 deletions

View File

@ -20,6 +20,9 @@ import (
// take permanent effect only after a successful return is seen in
// caller.
//
// The maximum batch size and delay can be adjusted with DB.MaxBatchSize
// and DB.MaxBatchDelay, respectively.
//
// Batch is only useful when there are multiple goroutines calling it.
func (db *DB) Batch(fn func(*Tx) error) error {
errCh := make(chan error, 1)