@@ -42,6 +42,19 @@ import qualified Streamly.Internal.Data.Array as Array
4242
4343import GHC.Exts
4444
45+--------------------------------------------------------------------------------
46+-- Developer Note
47+--------------------------------------------------------------------------------
48+
49+-- IMPORTANT
50+-- =========
51+--
52+-- Don't ever serialize the offsets in the encoding. Serialize length instead.
53+-- Offsets are NOT stable.
54+--
55+-- They will only work if the start offset of the Array when encoding and
56+-- decoding is the same. This is almost never the case.
57+
4558--------------------------------------------------------------------------------
4659-- Types
4760--------------------------------------------------------------------------------