Skip to content
This repository has been archived by the owner on Dec 18, 2023. It is now read-only.

Fix comments for Grumpkin curve generator #175

Merged
merged 3 commits into from
Sep 19, 2023
Merged

Fix comments for Grumpkin curve generator #175

merged 3 commits into from
Sep 19, 2023

Conversation

Pratyush
Copy link
Member

@Pratyush Pratyush commented Sep 7, 2023

Description

Fixes incorrect docs for Grumpkin


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against correct branch (master)
  • Linked to Github issue with discussion and accepted design OR have an explanation in the PR that describes this work.
  • Wrote unit tests
  • Updated relevant documentation in the code
  • Added a relevant changelog entry to the Pending section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer

@CPerezz
Copy link
Contributor

CPerezz commented Sep 7, 2023

I see what happened finally.
The halo2curves docs point to https://github.com/privacy-scaling-explorations/halo2curves/blob/6e2ff3853c8fe91300650a733100640dacf313e6/src/grumpkin/curve.rs#L43 a commit specifically which contains the wrong docs.

Therefore, in the latest master, this was already fixed in barretenberg. See: AztecProtocol/barretenberg@f2eca7d

Apologies for the inconvenience and the doc nits @Pratyush 🙏

@CPerezz
Copy link
Contributor

CPerezz commented Sep 7, 2023

Added a relevant changelog entry to the Pending section in CHANGELOG.md

Wasn't done. Should I do a PR for it?

@Pratyush
Copy link
Member Author

Pratyush commented Sep 7, 2023

I can add it to this PR!

@Pratyush Pratyush merged commit 8c0256a into master Sep 19, 2023
33 checks passed
@Pratyush Pratyush deleted the grumpkin-docs branch September 19, 2023 11:47
Shigoto-dev19 pushed a commit to Shigoto-dev19/ark-babyjub that referenced this pull request Sep 23, 2023
Co-authored-by: Weikeng Chen <w.k@berkeley.edu>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants