Skip to content

Commit

Permalink
docs: Update godoc for default values (#1665)
Browse files Browse the repository at this point in the history
This updates the godoc for the following:

ValueThreshold based on #1664
stream.NumGo based on #1593
  • Loading branch information
danielmai authored Feb 16, 2021
1 parent 62c9ad2 commit f68f36a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion options.go
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ func (opt Options) WithMaxLevels(val int) Options {
// ValueThreshold sets the threshold used to decide whether a value is stored directly in the LSM
// tree or separately in the log value files.
//
// The default value of ValueThreshold is 1 KB, but LSMOnlyOptions sets it to maxValueThreshold.
// The default value of ValueThreshold is 1 MB, but LSMOnlyOptions sets it to maxValueThreshold.
func (opt Options) WithValueThreshold(val int64) Options {
opt.ValueThreshold = val
return opt
Expand Down
2 changes: 1 addition & 1 deletion stream.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ type Stream struct {
// iterate over the entire DB.
Prefix []byte

// Number of goroutines to use for iterating over key ranges. Defaults to 16.
// Number of goroutines to use for iterating over key ranges. Defaults to 8.
NumGo int

// Badger would produce log entries in Infof to indicate the progress of Stream. LogPrefix can
Expand Down

0 comments on commit f68f36a

Please sign in to comment.