Skip to content

Commit

Permalink
docs: Fix "an" article usage (risc0#2274)
Browse files Browse the repository at this point in the history
  • Loading branch information
nvzqz authored Aug 30, 2024
1 parent 6b6daea commit d559477
Show file tree
Hide file tree
Showing 18 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/doc_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ body:
id: stackexchange
attributes:
label: Experiencing problems? Have you tried our Discord first?
description: Please search <https://discord.com/invite/risczero> to see if an post already exists, and ask if not. Please do not file support issues here.
description: Please search <https://discord.com/invite/risczero> to see if a post already exists, and ask if not. Please do not file support issues here.
options:
- label: This is not a support question.
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ body:
id: stackexchange
attributes:
label: Experiencing problems? Have you tried our Discord first?
description: Please search <https://discord.com/invite/risczero> to see if an post already exists, and ask if not. Please do not file support issues here.
description: Please search <https://discord.com/invite/risczero> to see if a post already exists, and ask if not. Please do not file support issues here.
options:
- label: This is not a support question.
required: true
Expand Down
4 changes: 2 additions & 2 deletions bonsai/sdk/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ pub mod responses {
use risc0_groth16::Seal;
use serde::{Deserialize, Serialize};

/// Response of a upload request
/// Response of an upload request
#[derive(Deserialize, Serialize)]
pub struct UploadRes {
/// Presigned URL to be supplied to a PUT request
Expand Down Expand Up @@ -298,7 +298,7 @@ pub mod responses {

/// Snark Receipt object
///
/// All relevant data to verify both the snark proof an corresponding
/// All relevant data to verify both the snark proof a corresponding
/// imageId on chain.
#[derive(Debug, Deserialize, Serialize, PartialEq)]
pub struct SnarkReceipt {
Expand Down
2 changes: 1 addition & 1 deletion risc0/build_kernel/kernels/metal/fp.h
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ class Fp {
}
};

/// Raise an value to a power
/// Raise a value to a power
constexpr inline Fp pow(Fp x, size_t n) {
Fp tot = 1;
while (n != 0) {
Expand Down
2 changes: 1 addition & 1 deletion risc0/build_kernel/kernels/metal/fpext.h
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ constexpr inline FpExt inv(FpExt in) {
#define a in.elems
// Compute the multiplicative inverse by basically looking at FpExt as a composite field and using
// the same basic methods used to invert complex numbers. We imagine that initially we have a
// numerator of 1, and an denominator of a. i.e out = 1 / a; We set a' to be a with the first and
// numerator of 1, and a denominator of a. i.e out = 1 / a; We set a' to be a with the first and
// third components negated. We then multiply the numerator and the denominator by a', producing
// out = a' / (a * a'). By construction (a * a') has 0's in it's first and third elements. We
// call this number, 'b' and compute it as follows.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ fn main() {

// An executor environment describes the configurations for the zkVM
// including program inputs.
// An default ExecutorEnv can be created like so:
// A default ExecutorEnv can be created like so:
// `let env = ExecutorEnv::builder().build().unwrap();`
// However, this `env` does not have any inputs.
//
Expand Down
2 changes: 1 addition & 1 deletion risc0/circuit/recursion-sys/cxx/fpext.h
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ constexpr inline FpExt inv(FpExt in) {
#define a in.elems
// Compute the multiplicative inverse by basically looking at FpExt as a composite field and using
// the same basic methods used to invert complex numbers. We imagine that initially we have a
// numerator of 1, and an denominator of a. i.e out = 1 / a; We set a' to be a with the first and
// numerator of 1, and a denominator of a. i.e out = 1 / a; We set a' to be a with the first and
// third components negated. We then multiply the numerator and the denominator by a', producing
// out = a' / (a * a'). By construction (a * a') has 0's in it's first and third elements. We
// call this number, 'b' and compute it as follows.
Expand Down
2 changes: 1 addition & 1 deletion risc0/circuit/rv32im-sys/cxx/fpext.h
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ constexpr inline FpExt inv(FpExt in) {
#define a in.elems
// Compute the multiplicative inverse by basically looking at FpExt as a composite field and using
// the same basic methods used to invert complex numbers. We imagine that initially we have a
// numerator of 1, and an denominator of a. i.e out = 1 / a; We set a' to be a with the first and
// numerator of 1, and a denominator of a. i.e out = 1 / a; We set a' to be a with the first and
// third components negated. We then multiply the numerator and the denominator by a', producing
// out = a' / (a * a'). By construction (a * a') has 0's in it's first and third elements. We
// call this number, 'b' and compute it as follows.
Expand Down
4 changes: 2 additions & 2 deletions risc0/sys/cxx/vendor/nvtx3/nvToolsExt.h
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@
* name, such as some OS thread creation APIs. This API support resource naming though
* both through resource objects and functions following the pattern
* nvtxName[RESOURCE_TYPE][A|W](identifier, name). Resource objects introduced in NVTX_VERSION 2
* supersede the other functions with a a more general method of assigning names to OS resources,
* supersede the other functions with a more general method of assigning names to OS resources,
* along with associating them to domains too. The older nvtxName* functions are only associated
* with the default domain.
* \section EXTENSIONS Optional Extensions
Expand Down Expand Up @@ -1298,7 +1298,7 @@ NVTX_DECLSPEC void NVTX_API nvtxNameOsThreadW(uint32_t threadId, const wchar_t*
*
* Registered strings are intended to increase performance by lowering instrumentation
* overhead. String may be registered once and the handle may be passed in place of
* a string where an the APIs may allow.
* a string where the APIs may allow.
*
* See \ref STRING_REGISTRATION for more details
*
Expand Down
2 changes: 1 addition & 1 deletion risc0/sys/kernels/zkp/cuda/fp.h
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ class Fp {
}
};

/// Raise an value to a power
/// Raise a value to a power
__device__ constexpr inline Fp pow(Fp x, size_t n) {
Fp tot = 1;
while (n != 0) {
Expand Down
2 changes: 1 addition & 1 deletion risc0/sys/kernels/zkp/cuda/fpext.h
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ __device__ constexpr inline FpExt inv(FpExt in) {
#define a in.elems
// Compute the multiplicative inverse by basically looking at FpExt as a composite field and using
// the same basic methods used to invert complex numbers. We imagine that initially we have a
// numerator of 1, and an denominator of a. i.e out = 1 / a; We set a' to be a with the first and
// numerator of 1, and a denominator of a. i.e out = 1 / a; We set a' to be a with the first and
// third components negated. We then multiply the numerator and the denominator by a', producing
// out = a' / (a * a'). By construction (a * a') has 0's in it's first and third elements. We
// call this number, 'b' and compute it as follows.
Expand Down
2 changes: 1 addition & 1 deletion risc0/zkp/src/core/hash/poseidon2/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ pub fn poseidon2_mix(cells: &mut [BabyBearElem; CELLS]) {
}
}

/// Perform a unpadded hash of a vector of elements. Because this is unpadded
/// Perform an unpadded hash of a vector of elements. Because this is unpadded
/// collision resistance is only true for vectors of the same size. If the size
/// is variable, this is subject to length extension attacks.
pub fn unpadded_hash<'a, I>(iter: I) -> [BabyBearElem; CELLS_OUT]
Expand Down
4 changes: 2 additions & 2 deletions risc0/zkvm/src/host/server/prove/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -829,8 +829,8 @@ mod sys_verify {

#[test]
fn sys_verify_integrity_halt_1() {
// Generate a receipt for a execution ending in a guest error indicated by
// ExitCode::Halted(1).
// Generate a receipt for an execution ending in a guest error indicated
// by ExitCode::Halted(1).
let halt_receipt = prove_halt(1);

let spec = &MultiTestSpec::SysVerifyIntegrity {
Expand Down
2 changes: 1 addition & 1 deletion risc0/zkvm/src/receipt_claim.rs
Original file line number Diff line number Diff line change
Expand Up @@ -590,7 +590,7 @@ pub(crate) trait Merge: Digestible + Sized {

/// Merge two structs to assigning self as the union of the fields populated in the two inputs.
fn merge_with(&mut self, other: &Self) -> Result<(), MergeInequalityError> {
// Not an very efficient implementation.
// Not a very efficient implementation.
*self = self.merge(other)?;
Ok(())
}
Expand Down
2 changes: 1 addition & 1 deletion website/api/zkvm/optimization.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ cycles per page, or 1.35 cycles per byte.
In order to support continuation after the segment ends (i.e. the zkVM
"hibernates"), it needs to **page-out** pages that were modified. Paging-out
takes the same number of operations as paging-in, so for the first time any
given page is written to in a segment, there is an page-out cost of 1094 to 5130
given page is written to in a segment, there is a page-out cost of 1094 to 5130
cycles.

If, after profiling your application, you learn page-in and page-out operations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ cycles per page, or 1.35 cycles per byte.
In order to support continuation after the segment ends (i.e. the zkVM
"hibernates"), it needs to **page-out** pages that were modified. Paging-out
takes the same number of operations as paging-in, so for the first time any
given page is written to in a segment, there is an page-out cost of 1094 to 5130
given page is written to in a segment, there is a page-out cost of 1094 to 5130
cycles.

If, after profiling your application, you learn page-in and page-out operations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ cycles per page, or 1.35 cycles per byte.
In order to support continuation after the segment ends (i.e. the zkVM
"hibernates"), it needs to **page-out** pages that were modified. Paging-out
takes the same number of operations as paging-in, so for the first time any
given page is written to in a segment, there is an page-out cost of 1094 to 5130
given page is written to in a segment, there is a page-out cost of 1094 to 5130
cycles.

If, after profiling your application, you learn page-in and page-out operations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ cycles per page, or 1.35 cycles per byte.
In order to support continuation after the segment ends (i.e. the zkVM
"hibernates"), it needs to **page-out** pages that were modified. Paging-out
takes the same number of operations as paging-in, so for the first time any
given page is written to in a segment, there is an page-out cost of 1094 to 5130
given page is written to in a segment, there is a page-out cost of 1094 to 5130
cycles.

If, after profiling your application, you learn page-in and page-out operations
Expand Down

0 comments on commit d559477

Please sign in to comment.