The Usage of Bendy Butt feed format section of the spec currently defines what MUST be done but doesn't explicitly describe what MAY be done. The additional allowances are illustrated implicitly through the examples.
I've been confused by this more than once (I incorrectly interpreted 'MUST do this' as 'MUSTonly do this'); perhaps we could add explicit clarification at the bottom of the section? Maybe something like this:
In addition to the compulsory criteria described above, the content dictionary MAY include additional arbitrary data fields as required. Examples include a feedpurpose field on a metafeed/add message and a reason on a metafeed/tombstone message.
arj03
commented
3 years ago
Related to https://github.com/ssb-ngi-pointer/ssb-meta-feeds/pull/18#discussion_r683425353
The Usage of Bendy Butt feed format section of the spec currently defines what MUST be done but doesn't explicitly describe what MAY be done. The additional allowances are illustrated implicitly through the examples.
I've been confused by this more than once (I incorrectly interpreted 'MUST do this' as 'MUST only do this'); perhaps we could add explicit clarification at the bottom of the section? Maybe something like this: