Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mistake or confusing example of symbol names in README #356

Open
Erudition opened this issue Sep 30, 2024 · 1 comment
Open

Mistake or confusing example of symbol names in README #356

Erudition opened this issue Sep 30, 2024 · 1 comment

Comments

@Erudition
Copy link

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
Copy link
Member

rvagg commented Oct 1, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants