Fix: multiple typos of different importance (#317)

* typo

* fixed for convenience

* typos

* multiple typos

Author: crStiv

bin/pre-commit.sh

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 # This script runs the same checks as the github CI;
-#  it can be used a a pre-commit hook.
+#  it can be used as a pre-commit hook.
 
 set -e
 

cli/progress-bar/src/thread.rs

@@ -36,7 +36,7 @@ impl ThreadHandle {
 impl Drop for ThreadHandle {
     fn drop(&mut self) {
         let Self { sender, join_handle } = self;
-        // SAFETY: struct fields are not accessible once `drop` returns.
+        // SAFETY: struct fields are inaccessible once `drop` returns.
         unsafe { ManuallyDrop::drop(sender) };
         let join_handle = unsafe { ManuallyDrop::take(join_handle) };
 

cli/src/command/prove.rs

@@ -23,7 +23,7 @@ pub struct ProveArgs {
     #[command(flatten)]
     pub common_args: CommonProveArgs,
 
-    /// Send prove request to the network.
+    /// Send proof request to the network.
     #[arg(long, conflicts_with_all = ["k", "pp_file", "impl"])]
     pub network: bool,
 
@@ -54,7 +54,7 @@ pub struct LocalProveArgs {
 
 #[derive(Debug, Args)]
 pub struct CommonProveArgs {
-    /// Build artifacts with the specified profile. "release" is default.
+    /// Build artifacts with the specified profile. "release" is the default.
     #[arg(long, default_value = "release")]
     pub profile: String,
 

core/src/prover/hypernova/error.rs

@@ -13,16 +13,16 @@ pub use crate::prover::nova::error::ProofError as NovaProofError;
 /// Errors related to proof generation
 #[derive(Debug)]
 pub enum ProofError {
-    /// An error occured loading or executing program
+    /// An error occurred while loading or executing the program
     NexusVMError(NexusVMError),
 
-    /// An error occurred reading file system
+    /// An error occurred reading the file system
     IOError(std::io::Error),
 
-    /// An error occured during circuit synthesis
+    /// An error occurred during circuit synthesis
     CircuitError(SynthesisError),
 
-    /// An error occured serializing to disk
+    /// An error occurred serializing to disk
     SerError(SerializationError),
 
     /// The witness does not satisfy the constraints as R1CS
@@ -34,13 +34,13 @@ pub enum ProofError {
     /// Invalid folding step index
     InvalidIndex(usize),
 
-    /// Public Parameters do not match circuit
+    /// Public Parameters do not match the circuit
     InvalidPP,
 
-    /// An error occured while computing the HyperNova folding
+    /// An error occurred while computing the HyperNova folding
     FoldingError(HNFoldingError),
 
-    /// An error occured while setting up a polynomial commitment
+    /// An error occurred while setting up a polynomial commitment
     PolyCommitmentError,
 
     /// The HyperNova prover produced an invalid proof
@@ -95,8 +95,8 @@ impl From<NovaProofError> for ProofError {
             NovaProofError::IOError(e) => IOError(e),
             NovaProofError::CircuitError(e) => CircuitError(e),
             NovaProofError::SerError(e) => SerError(e),
-            // The above error conversions allow reusing convienence functions
-            // from the nova implemementation in this crate.
+            // The above error conversions allow reusing convenience functions
+            // from the nova implementation in this crate.
             //
             // The remaining errors are thrown by functions that are specific to
             // a proof system, and so shouldn't be shared across the definitions