cobs.rs icon indicating copy to clipboard operation
cobs.rs copied to clipboard

Clarify documentation for sentinel behavior of `*encode*` fns

Open starthal opened this issue 3 years ago • 1 comments

The documentation describes that encode, try_encode, etc. "use" the default sentinel value (or override it). IMO they should clarify that the functions do not actually write the sentinel to the buffer.

This is documented in CobsEncoder::finalize but not the free functions that use it.

starthal avatar Aug 09 '22 14:08 starthal

I agree, I would really expect encode to append the sentinel as is the point of COBS

rockboynton avatar Mar 31 '23 01:03 rockboynton