PR FIXUP - Document encoding funcs

sourcenetwork · Jul 8, 2024 · b0fef1d · b0fef1d
1 parent 0488b30
commit b0fef1d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/internal/core/encoding.go b/internal/core/encoding.go
@@ -289,6 +289,7 @@ func EncodeIndexDataStoreKey(key *IndexDataStoreKey) []byte {
 	return b
 }
 
+// DecodeDataStoreKey decodes a store key into a [DataStoreKey].
 func DecodeDataStoreKey(data []byte) (DataStoreKey, error) {
 	if len(data) == 0 {
 		return DataStoreKey{}, ErrEmptyKey
@@ -340,6 +341,7 @@ func DecodeDataStoreKey(data []byte) (DataStoreKey, error) {
 	}, nil
 }
 
+// EncodeDataStoreKey encodes a [*DataStoreKey] to a byte array suitable for sorting in the store.
 func EncodeDataStoreKey(key *DataStoreKey) []byte {
 	var result []byte