Core Lib Documentation: byte_array module

[TAdev0]

No description provided.

[reviewable-StarkWare]

This change is 

[orizi]

Reviewed all commit messages.
Reviewable status: 0 of 1 files reviewed, 1 unresolved discussion (waiting on @TAdev0)

---

corelib/src/byte_array.cairo line 2 at r2 (raw file):

//! A dynamic, growable array of bytes where bytes are stored in multiples of 31 bytes,
//! with a `felt252` pending word used for bytes that don't complete a full `bytes31` word.

This sounds like an implementation detail.

can be included - but shouldn't be the start.

Note that the pub part of the ByteArray does not include this info.

Code quote:

//! A dynamic, growable array of bytes where bytes are stored in multiples of 31 bytes,
//! with a `felt252` pending word used for bytes that don't complete a full `bytes31` word.

[TAdev0]

@orizi just updated, moving this sentence right before the ByteArray struct definition

[orizi]

Reviewed all commit messages.
Reviewable status: 0 of 1 files reviewed, 2 unresolved discussions (waiting on @TAdev0)

---

corelib/src/byte_array.cairo line 68 at r3 (raw file):

// TODO(yuval): don't allow creation of invalid ByteArray?
/// A dynamic, growable array of bytes where bytes are stored in multiples of 31 bytes,

same implementation detail - should probably not be emphasized.

[orizi]

Reviewed all commit messages.
Reviewable status: 0 of 1 files reviewed, 2 unresolved discussions (waiting on @TAdev0)

---

corelib/src/byte_array.cairo line 73 at r4 (raw file):

// TODO(yuval): don't allow creation of invalid ByteArray?
/// Cairo's `String` type.

it isn't - it is a bytearray - the string literal but can be used with it - but it deliberately isn't a string.

[orizi]

Reviewed 1 of 1 files at r5, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @TAdev0)