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.

Sign up for GitHub

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

Jump to bottom

Mistake or confusing example of symbol names in README #356

Closed
Erudition opened this issue Sep 30, 2024 · 3 comments
Closed

Mistake or confusing example of symbol names in README #356

Erudition opened this issue Sep 30, 2024 · 3 comments

Comments

@Erudition
Copy link
Contributor

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"

Erudition added a commit to Erudition/multicodec that referenced this issue Oct 15, 2024
@Erudition
Correction for multiformats#356
7528fb1
@Erudition
Copy link
Contributor Author

Sure, done: #361

@rvagg
Copy link
Member

rvagg commented Oct 16, 2024

thanks!

@rvagg rvagg closed this as completed Oct 16, 2024
rvagg added a commit that referenced this issue Oct 16, 2024
@rvagg
fix: rename bls-12381* to bls12_381* for consistency
d885c7b 
The poseidon bls12 entries already exist to mark this convention and we have a note in the README that calls this example out specifically.

Ref: #291
Ref: #361
Ref: #356
@rvagg rvagg mentioned this issue Oct 16, 2024
Merged
rvagg added a commit that referenced this issue Oct 24, 2024
@rvagg
fix: rename bls-12381* to bls12_381* for consistency (#362)
352d05a 
The poseidon bls12 entries already exist to mark this convention and we have a note in the README that calls this example out specifically.

Ref: #291
Ref: #361
Ref: #356
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rvagg @Erudition