Fix docs (easy) #291
Merged
Fix docs (easy) #291
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
huitseeker
requested review from
adr1anh,
porcuquine,
samuelburnham,
winston-h-zhang and
mpenciak
mpenciak
reviewed
Feb 1, 2024
| @@ -1,5 +1,5 @@ | |||
| //! This module implements Nova's evaluation engine using `HyperKZG`, a KZG-based polynomial commitment for multilinear polynomials | |||
| //! HyperKZG is based on the transformation from univariate PCS to multilinear PCS in the Gemini paper (section 2.4.2 in https://eprint.iacr.org/2022/420.pdf). | |||
| //! HyperKZG is based on the transformation from univariate PCS to multilinear PCS in the Gemini paper (section 2.4.2 in `<https://eprint.iacr.org/2022/420.pdf>`). | |||
There was a problem hiding this comment.
Is this the correct way to denote URLs in markdown?
There was a problem hiding this comment.
It is in Rustdoc https://doc.rust-lang.org/beta/rustdoc/lints.html#bare_urls
- Updated references in documentation comments, changing from Kotlin-style to rustdoc style. - Corrected the use of brackets to backticks for proper Rust code referencing in the comments in the `lib.rs` and `r1cs/mod.rs` files. - The changes made were purely stylistic and cosmetic. No modifications were made to the actual code logic or implementation.
- Updated hyperlink format in `HyperKZG` module documentation. - CI should be testing this when rust-lang/rust#56232 resolves.
mpenciak
approved these changes
Feb 1, 2024
samuelburnham
pushed a commit
to samuelburnham/arecibo
that referenced
this pull request
Feb 2, 2024
* add bitwise AND example (argumentcomputer#289) * add bitwise AND example * fix cargo clippy * Fix typos (argumentcomputer#290) * fix typo * fix typo * Fix typo * Remove absorbing of running instance (argumentcomputer#291) * Remove absorbing of running instance * Update value of NUM_FE_FOR_RO * Update expected values in tests * Add comment * cargo fmt * relax requirements on the size of public IO and add a note about NIFS (argumentcomputer#294) * relax requirements on the size of public IO * add a note --------- Co-authored-by: Srinath Setty <[email protected]> Co-authored-by: GoodDaisy <[email protected]> Co-authored-by: Varun Thakore <[email protected]>
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.
Improves rustdoc formatting, fixes one error which is throwing up our CI:
https://github.com/lurk-lab/arecibo/actions/workflows/docs.yml