multiformats / multicodec

Compact self-describing codecs. Save space by using predefined multicodec tables.
MIT License
340 stars 204 forks source link

Mistake or confusing example of symbol names in README #356

Closed Erudition closed 1 month ago

Erudition commented 1 month ago

https://github.com/multiformats/multicodec/blob/badcfe56bb7e0bbb06b60d57565186cd6be1f932/README.md?plain=1#L65C398-L65C589

example: bls12_381-g1-pub contains 3 parts: bls_381, g1 and pub, where bls_381 is "BLS 381" which is not commonly written as "BLS381" and therefore requires a secondary separator.

Those "3 parts" combine to bls_381_g1_pub, not bls12_381-g1-pub. Was the 12 an oversight, or is there something about this format that makes it not considered one of these parts?

rvagg commented 1 month ago

oversight, good pickup though, would you mind opening a PR to fix it? it should talk about "BLS12"

Erudition commented 1 month ago

Sure, done: #361

rvagg commented 1 month ago

thanks!