on master help sign in
Add a section about byte/chunk stream naming
4e35d0dHarendra Kumar
dev/container-api.md+7
@@ -7,6 +7,13 @@ module means converting the array to bytes, it sounds intuitive if read
7qualified with the module name e.g. Array.toBytes. This doc lists some
7qualified with the module name e.g. Array.toBytes. This doc lists some
8conventions and guidelines to be followed.
8conventions and guidelines to be followed.
9
9
10+## Bytes and Chunks
11+
12+APIs that deal with streams of Word8 may have "bytes" in their names
13+while the ones dealing with "Array Word8" have "chunks" in their
14+names. Usually the default is bytes when there is no explicit mention in
15+the name.
16+
10## Unfolds and Folds
17## Unfolds and Folds
11
18
12* Unfolds are named as "read" or with a "read" prefix (e.g. readChunks).
19* Unfolds are named as "read" or with a "read" prefix (e.g. readChunks).