Skip to content

Commit

Permalink
docs: fix function comments (#21555)
Browse files Browse the repository at this point in the history
  • Loading branch information
winniehere authored Sep 5, 2024
1 parent 6b20ef7 commit 3d0fba5
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion collections/quad.go
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ func NewSuperPrefixedQuadRange[K1, K2, K3, K4 any](k1 K1, k2 K2) Ranger[Quad[K1,
}
}

// NewSuperPrefixedQuadRange provides a Range for all keys prefixed with the given
// NewSuperPrefixedQuadRange3 provides a Range for all keys prefixed with the given
// first, second and third parts of the Quad key.
func NewSuperPrefixedQuadRange3[K1, K2, K3, K4 any](k1 K1, k2 K2, k3 K3) Ranger[Quad[K1, K2, K3, K4]] {
key := QuadSuperPrefix3[K1, K2, K3, K4](k1, k2, k3)
Expand Down
8 changes: 4 additions & 4 deletions store/v2/db/rocksdb.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,16 @@ var (
defaultReadOpts = grocksdb.NewDefaultReadOptions()
)

// RocksDB implements `corestore.KVStoreWithBatch` using RocksDB as the underlying storage engine.
// It is used for only store v2 migration, since some clients use RocksDB as
// RocksDB implements `corestore.KVStoreWithBatch`, using RocksDB as the underlying storage engine.
// It is only used for store v2 migration, since some clients use RocksDB as
// the IAVL v0/v1 backend.
type RocksDB struct {
storage *grocksdb.DB
}

// defaultRocksdbOptions, good enough for most cases, including heavy workloads.
// defaultRocksdbOptions is good enough for most cases, including heavy workloads.
// 1GB table cache, 512MB write buffer(may use 50% more on heavy workloads).
// compression: snappy as default, need to -lsnappy to enable.
// compression: snappy as default, use `-lsnappy` flag to enable.
func defaultRocksdbOptions() *grocksdb.Options {
bbto := grocksdb.NewDefaultBlockBasedTableOptions()
bbto.SetBlockCache(grocksdb.NewLRUCache(1 << 30))
Expand Down

0 comments on commit 3d0fba5

Please sign in to comment.