Update comments about encoding format

onflow · Sep 19, 2023 · efc46e6 · efc46e6
1 parent c178a72
commit efc46e6
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 12 deletions.
diff --git a/array.go b/array.go
@@ -534,9 +534,9 @@ func newArrayDataSlabFromDataV1(
 // version 1 with CBOR tag having tag number CBORTagInlinedArray, and tag contant
 // as 3-element array:
 //
-// - index of inlined extra data
-// - value ID index
-// - CBOR array of elements
+//	+------------------+----------------+----------+
+//	| extra data index | value ID index | elements |
+//	+------------------+----------------+----------+
 //
 // NOTE: This function doesn't decode tag number because tag number is decoded
 // in the caller and decoder only contains tag content.
@@ -641,9 +641,9 @@ func DecodeInlinedArrayStorable(
 // version 1 with CBOR tag having tag number CBORTagInlinedArray,
 // and tag contant as 3-element array:
 //
-// - index of inlined extra data
-// - value ID index
-// - CBOR array of elements
+//	+------------------+----------------+----------+
+//	| extra data index | value ID index | elements |
+//	+------------------+----------------+----------+
 func (a *ArrayDataSlab) encodeAsInlined(enc *Encoder, inlinedTypeInfo *inlinedExtraData) error {
 	if a.extraData == nil {
 		return NewEncodingError(

diff --git a/map.go b/map.go
@@ -2507,9 +2507,9 @@ func DecodeInlinedCompositeStorable(
 // version 1 with CBOR tag having tag number CBORTagInlinedMap, and tag contant
 // as 3-element array:
 //
-// - index of inlined extra data
-// - value ID index
-// - CBOR array of elements
+//	+------------------+----------------+----------+
+//	| extra data index | value ID index | elements |
+//	+------------------+----------------+----------+
 //
 // NOTE: This function doesn't decode tag number because tag number is decoded
 // in the caller and decoder only contains tag content.
@@ -2741,9 +2741,9 @@ func (m *MapDataSlab) encodeElements(enc *Encoder, inlinedTypes *inlinedExtraDat
 // version 1 with CBOR tag having tag number CBORTagInlinedMap,
 // and tag contant as 3-element array:
 //
-// - index of inlined extra data
-// - value ID index
-// - CBOR array of elements
+//	+------------------+----------------+----------+
+//	| extra data index | value ID index | elements |
+//	+------------------+----------------+----------+
 func (m *MapDataSlab) encodeAsInlined(enc *Encoder, inlinedTypeInfo *inlinedExtraData) error {
 	if m.extraData == nil {
 		return NewEncodingError(