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

Foreign fields pt 2 #777

Merged
merged 14 commits into from
Dec 8, 2023
Merged

Foreign fields pt 2 #777

merged 14 commits into from
Dec 8, 2023

Conversation

mitschabaude
Copy link
Contributor

@mitschabaude mitschabaude commented Dec 7, 2023

Additional content about foreign fields on top of #774

TODO:

  • build API reference for ForeignField and update links that should point to it

Copy link

vercel bot commented Dec 7, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 8, 2023 8:22am
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
07-oracles ⬜️ Ignored (Inspect) Visit Preview Dec 8, 2023 8:22am

@mitschabaude mitschabaude marked this pull request as ready for review December 7, 2023 16:37
@mitschabaude mitschabaude requested a review from a team as a code owner December 7, 2023 16:37

#### Defined in

[lib/foreign-field.ts:477](https://github.com/o1-labs/snarkyjs/blob/9d34c7fcf/src/lib/foreign-field.ts#L477)
Copy link
Contributor

Choose a reason for hiding this comment

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

I know that this link auto-resolves to o1js, but do we want to keep snarkyjs in our links?


# Class: Unconstrained<T\>

Container which holds an unconstrained value. This can be used to pass values
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Container which holds an unconstrained value. This can be used to pass values
Container which holds an unconstrained value. You can use this to pass values

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't know if we want to make the API docs actionable, but if we did, this would be a valid suggestion

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks. The API docs are generated so changing them here is not the right place, I will take it as feedback for improving the doccomments

Copy link
Contributor

@barriebyron barriebyron left a comment

Choose a reason for hiding this comment

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

@mitschabaude see the minor update suggestions.
Our docs style is to use the second person pronoun "you" and avoid using third person "we"
https://developers.google.com/style/person

Co-authored-by: Barrie Byron <barrie@o1labs.org>
@mitschabaude mitschabaude merged commit b53258f into ff-arithmetic Dec 8, 2023
2 checks passed
@mitschabaude mitschabaude deleted the ff-arithmetic-2 branch December 8, 2023 08:32
@barriebyron barriebyron added docs Improvements or additions to documentation o1js labels Dec 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation o1js
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants