Feature/update snarkyjs docs #917
Conversation
There was a problem hiding this comment.
these updates are so improved, good job @yunus433
Thank you for these valuable contributions.
My feedback is quite granular and editorial in nature. Questions? please ask
src/snarky.d.ts
Outdated
| * | ||
| * The field is the [pasta base field](https://electriccoin.co/blog/the-pasta-curves-for-halo-2-and-beyond/) of order 2^254 + 0x224698fc094cf91b992d30ed00000001 ({@link Field.ORDER}). | ||
| * | ||
| * You can create a new Field from everything "field-like" (`bigint`, integer, `number`, decimal, `string`, `Field`). |
There was a problem hiding this comment.
see earlier comment about code literals and whether we want single tick marks for only some of these "everything" items. Wherever we land, please make changes through for consistency
src/snarky.d.ts
Outdated
| * new Field("abc"); // ERROR: Invalid argument "abc" | ||
| * ``` | ||
| * | ||
| * Creating a {@link Field} from a negative number may result in an unexpected behaviour if you are not familiar with [modular arithmatic](https://en.wikipedia.org/wiki/Modular_arithmetic). |
There was a problem hiding this comment.
There was a problem hiding this comment.
Hey @barriebyron, I myself cannot tell what you mean here since you only link to a line of code. Maybe linking to an earlier PR comment would be clearer?
There was a problem hiding this comment.
these updates are so improved, good job @yunus433
Thank you for these valuable contributions.
My feedback is quite granular and editorial in nature. Questions? please ask
There was a problem hiding this comment.
these updates are so improved, good job @yunus433
Thank you for these valuable contributions.
My feedback is quite granular and editorial in nature. Questions? please ask
There was a problem hiding this comment.
these updates are so improved, good job @yunus433
Thank you for these valuable contributions.
My feedback is quite granular and editorial in nature. Questions? please ask
|
Is there a reason you didn't use the old PR @yunus433? |
Co-authored-by: Barrie Byron <barrie@o1labs.org>
Co-authored-by: Gregor Mitscha-Baude <gregor.mitscha-baude@gmx.at>
Co-authored-by: Barrie Byron <barrie@o1labs.org>
Co-authored-by: Barrie Byron <barrie@o1labs.org>
Co-authored-by: Barrie Byron <barrie@o1labs.org>
Co-authored-by: Barrie Byron <barrie@o1labs.org>
Co-authored-by: Barrie Byron <barrie@o1labs.org>
Co-authored-by: Barrie Byron <barrie@o1labs.org>
Co-authored-by: Barrie Byron <barrie@o1labs.org>
Co-authored-by: Barrie Byron <barrie@o1labs.org>
Co-authored-by: Barrie Byron <barrie@o1labs.org>
Co-authored-by: Barrie Byron <barrie@o1labs.org>
Co-authored-by: Barrie Byron <barrie@o1labs.org>
Co-authored-by: Barrie Byron <barrie@o1labs.org>
Co-authored-by: Barrie Byron <barrie@o1labs.org>
Co-authored-by: Barrie Byron <barrie@o1labs.org>
I had an error on GitHub, and I thought that would fix it. But it didn't, I won't try this again :D (I have done the same in the past! I understand) thank you again! |
There was a problem hiding this comment.
@yunus433 your contributions are very helpful, thank you! One tiny suggestion you can accept if you like
Thank you!!
Co-authored-by: Barrie Byron <barrie@o1labs.org>
Hi @mitschabaude, I think now the merge issues are fixed, yet the PR needs a final review from @MartinMinkov to be merged. Thank you a lot :) |
|
Hi @barriebyron, can you please merge the request? I cannot since I do not have a write permission on the repo. Thank you a lot :) |
This PR adds useful developer-centric context, descriptions, and information
thank you @yunus433