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

Descriptions for some of bls12* methods #2368

Closed
DariuszDepta opened this issue Jan 31, 2025 · 1 comment · Fixed by #2375
Closed

Descriptions for some of bls12* methods #2368

DariuszDepta opened this issue Jan 31, 2025 · 1 comment · Fixed by #2375
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@DariuszDepta
Copy link
Member

DariuszDepta commented Jan 31, 2025

It would be nice to have some descriptions (in source code) to these methods, what they do and why they are in Api trait:

@DariuszDepta DariuszDepta added the documentation Improvements or additions to documentation label Jan 31, 2025
@aumetra aumetra self-assigned this Feb 3, 2025
@aumetra
Copy link
Member

aumetra commented Feb 10, 2025

The pairing equality method already has pretty good documentation IMO. And for the hash function I could only come up with one or two sentences. I'll PR it, maybe you can then have a look at it and let me know where there's gaps so I can fill them out.

I feel like there's the classic problem of "I wrote it and read the papers, so of course it's obvious to me".

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

Successfully merging a pull request may close this issue.

2 participants