trustoverip / tswg-cesr-specification

Composable Event Streaming Representation (CESR) Specification
https://trustoverip.github.io/tswg-cesr-specification/
Other
6 stars 8 forks source link

pre-padding section a little hard to parse #55

Closed daidoji closed 5 months ago

daidoji commented 7 months ago

pre-padding section a little hard to parse at first read. These sections do describe how to convert between domains and give various examples for the padding required to do this to make the whole scheme work out but do require a couple reads and working carefully through the examples to really get it to the point where one could implement from the spec.

These sections may be a bit easier to get through by splitting out the informative description of the reasons for padding (which is mostly done in the first section), maybe construct a set of emphasized algorithms in pseudo-code for implementer's clarity, and then examples of the various padding conversions explicitly listed by case (or include this in the annex) that refer back to the pseudo-code.

Right now I think the conversion/padding scheme, rationale for the scheme, and examples of the scheme are all interwoven quite closely in these sections making it a bit hard to pick out.

daidoji commented 5 months ago

Actually, I don't think I'll have time to do this one so I'll close with this comment.