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

chore: Document bn254 lib #4311

Merged
merged 2 commits into from
Feb 9, 2024
Merged

chore: Document bn254 lib #4311

merged 2 commits into from
Feb 9, 2024

Conversation

sirasistant
Copy link
Contributor

Description

Problem*

Resolves #4138

Summary*

Add some small docs and add code comments to explain the not-obvious checks.

Additional Context

Documentation*

Check one:

  • No documentation needed.
  • Documentation included in this PR.
  • [Exceptional Case] Documentation to be submitted in a separate PR.

PR Checklist*

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 9, 2024
@sirasistant sirasistant changed the title docs: Document bn254 lib chore: Document bn254 lib Feb 9, 2024
Copy link
Contributor

github-actions bot commented Feb 9, 2024

Copy link
Contributor

@signorecello signorecello left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect! Thank you!

@sirasistant sirasistant enabled auto-merge February 9, 2024 10:24
@sirasistant sirasistant added this pull request to the merge queue Feb 9, 2024
Merged via the queue into master with commit da4e86f Feb 9, 2024
34 checks passed
@sirasistant sirasistant deleted the arv/document_bn254_lt branch February 9, 2024 10:59
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 this pull request may close these issues.

Document the BN254 field comparison library
2 participants