Bring back comments in the Conway cddl spec

IntersectMBO / cardano-ledger

The ledger implementation and specifications of the Cardano blockchain.

Apache License 2.0

256 stars 158 forks source link

Bring back comments in the Conway cddl spec #4522

Open klntsky opened 1 month ago

klntsky commented 1 month ago

Please provide more comments explaining the semantics, and avoid magic constants

E.g. for https://github.com/IntersectMBO/cardano-ledger/blob/411054e40b4e08350049e4eaffdf0cc5f73e9d91/eras/conway/impl/cddl-files/conway.cddl#L20

The old explainer was very useful

stevenj commented 1 month ago

One possible solution to this which would help better define the address is use the .abnfb control operator from: https://www.rfc-editor.org/rfc/rfc9165.html to help define these kinds of fields.