From 7d9ea21e654900d91903d766475d706a74a1d679 Mon Sep 17 00:00:00 2001 From: Tnze Date: Tue, 21 Feb 2023 19:50:12 +0800 Subject: [PATCH] fix wrong comments, add new comments --- level/bitstorage.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/level/bitstorage.go b/level/bitstorage.go index b944dd7..842d4da 100644 --- a/level/bitstorage.go +++ b/level/bitstorage.go @@ -25,7 +25,7 @@ type BitStorage struct { valuesPerLong int } -// NewBitStorage create a new BitStorage. Return nil if bits == 0. +// NewBitStorage create a new BitStorage. // // The "bits" is the number of bits per value, which can be calculated by math/bits.Len() // The "length" is the number of values. @@ -195,6 +195,8 @@ func (b *BitStorage) WriteTo(w io.Writer) (int64, error) { return n, nil } +// Fix recalculate BitStorage internal values for given bits. +// Typically, you should call this method after ReadFrom is called, internal data is changed. func (b *BitStorage) Fix(bits int) error { if bits == 0 { b.mask = 0