Improve documentation via better READMEs #508
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pratyush
requested review from
mmagician and
weikengchen
and removed request for
a team
ValarDragon
reviewed
Nov 2, 2022
|
|
||
| let s1 = ScalarField::rand(&mut rng); | ||
| let s2 = ScalarField::rand(&mut rng); | ||
| let result = G::msm(&[a, b], &[s1, s2]); |
There was a problem hiding this comment.
something that reads odd, why is it group MSM, but GAffine base points?
(I understand the reason, just not sure if we want to note anything about this in README, or for simplicity make a,b in G)
There was a problem hiding this comment.
Good catch. I'll add some explanation there.
There was a problem hiding this comment.
I added an explanation in the example; let me know if this looks better =)
mmagician
reviewed
Nov 2, 2022
Co-authored-by: mmagician <[email protected]>
Co-authored-by: Dev Ojha <[email protected]>
…into feat/better-readmes
mmagician
approved these changes
Nov 3, 2022
andrewmilson
added a commit
to andrewmilson/algebra
that referenced
this pull request
Jan 1, 2023
* upstream/master: Update hashbrown requirement from 0.12.1 to 0.13.1 (arkworks-rs#515) Update libtest-mimic requirement from 0.5.2 to 0.6.0 (arkworks-rs#514) Update changelog (arkworks-rs#511) Add a Discord link (arkworks-rs#510) Improve documentation via better READMEs (arkworks-rs#508)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Improves the documentation for
ark-ff,ark-ec, andark-serializeby directly incorporating the content ofark-algebra-intro.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.
Pendingsection inCHANGELOG.mdFiles changedin the GitHub PR explorer