stat/combin: Fix CombinationGenerator comment (#1028)

It's confusing to say that Combination generates the next combination, when really it generates the current one with Next doing the advancing.
This commit is contained in:
Brendan Tracey
2019-07-23 10:12:18 +01:00
committed by GitHub
parent 4cb73befae
commit 9cfd3e46f1

View File

@@ -119,7 +119,7 @@ func (c *CombinationGenerator) Next() bool {
return true return true
} }
// Combination generates the next combination. If next is non-nil, it must have // Combination generates the current combination. If next is non-nil, it must have
// length k and the result will be stored in-place into combination. If combination // length k and the result will be stored in-place into combination. If combination
// is nil a new slice will be allocated and returned. If all of the combinations // is nil a new slice will be allocated and returned. If all of the combinations
// have already been constructed (Next() returns false), Combination will panic. // have already been constructed (Next() returns false), Combination will panic.