Update comments about encoding format

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

Hide file tree

Showing 2 changed files with 15 additions and 39 deletions.
diff --git a/array.go b/array.go
@@ -419,17 +419,11 @@ func newArrayDataSlabFromDataV0(
 
 // newArrayDataSlabFromDataV1 decodes data in version 1:
 //
-// Root DataSlab Header:
-//
-//	+-------------------------------+------------+---------------------------------+
-//	| slab version + flag (2 bytes) | extra data | inlined extra data (if present) |
-//	+-------------------------------+------------+---------------------------------+
-//
-// Non-root DataSlab Header:
+// DataSlab Header:
 //
-//	+-------------------------------+---------------------------------+-----------------------------+
-//	| slab version + flag (2 bytes) | inlined extra data (if present) | next slab ID (if non-empty) |
-//	+-------------------------------+---------------------------------+-----------------------------+
+//	+-------------------------------+----------------------+---------------------------------+-----------------------------+
+//	| slab version + flag (2 bytes) | extra data (if root) | inlined extra data (if present) | next slab ID (if non-empty) |
+//	+-------------------------------+----------------------+---------------------------------+-----------------------------+
 //
 // Content:
 //
@@ -713,17 +707,11 @@ func (a *ArrayDataSlab) encodeAsInlined(enc *Encoder, inlinedTypeInfo *inlinedEx
 
 // Encode encodes this array data slab to the given encoder.
 //
-// Root DataSlab Header:
-//
-//	+-------------------------------+------------+---------------------------------+
-//	| slab version + flag (2 bytes) | extra data | inlined extra data (if present) |
-//	+-------------------------------+------------+---------------------------------+
-//
-// Non-root DataSlab Header:
+// DataSlab Header:
 //
-//	+-------------------------------+---------------------------------+-----------------------------+
-//	| slab version + flag (2 bytes) | inlined extra data (if present) | next slab ID (if non-empty) |
-//	+-------------------------------+---------------------------------+-----------------------------+
+//	+-------------------------------+----------------------+---------------------------------+-----------------------------+
+//	| slab version + flag (2 bytes) | extra data (if root) | inlined extra data (if present) | next slab ID (if non-empty) |
+//	+-------------------------------+----------------------+---------------------------------+-----------------------------+
 //
 // Content:
 //

diff --git a/map.go b/map.go
@@ -2268,17 +2268,11 @@ func newMapDataSlabFromDataV0(
 
 // newMapDataSlabFromDataV1 decodes data in version 1:
 //
-// Root DataSlab Header:
-//
-//	+-------------------------------+------------+---------------------------------+
-//	| slab version + flag (2 bytes) | extra data | inlined extra data (if present) |
-//	+-------------------------------+------------+---------------------------------+
-//
-// Non-root DataSlab Header:
+// DataSlab Header:
 //
-//	+-------------------------------+---------------------------------+-----------------------------+
-//	| slab version + flag (2 bytes) | inlined extra data (if present) | next slab ID (if non-empty) |
-//	+-------------------------------+---------------------------------+-----------------------------+
+//	+-------------------------------+----------------------+---------------------------------+-----------------------------+
+//	| slab version + flag (2 bytes) | extra data (if root) | inlined extra data (if present) | next slab ID (if non-empty) |
+//	+-------------------------------+----------------------+---------------------------------+-----------------------------+
 //
 // Content:
 //
@@ -2610,15 +2604,9 @@ func DecodeInlinedMapStorable(
 //
 // Root DataSlab Header:
 //
-//	+-------------------------------+------------+---------------------------------+
-//	| slab version + flag (2 bytes) | extra data | inlined extra data (if present) |
-//	+-------------------------------+------------+---------------------------------+
-//
-// Non-root DataSlab Header:
-//
-//	+-------------------------------+---------------------------------+-----------------------------+
-//	| slab version + flag (2 bytes) | inlined extra data (if present) | next slab ID (if non-empty) |
-//	+-------------------------------+---------------------------------+-----------------------------+
+//	+-------------------------------+----------------------+---------------------------------+-----------------------------+
+//	| slab version + flag (2 bytes) | extra data (if root) | inlined extra data (if present) | next slab ID (if non-empty) |
+//	+-------------------------------+----------------------+---------------------------------+-----------------------------+
 //
 // Content:
 //