Merge branch 'main' into feat/rm-legacy

crates/circuits/primitives/src/lib.rs

@@ -1,7 +1,7 @@
 //! This crate contains a collection of primitives for use when building circuits.
-//! The primitives are separated into two types: standalone [Air](p3_air::Air)s and [SubAir]s.
+//! The primitives are separated into two types: standalone [Air](openvm_stark_backend::p3_air::Air)s and [SubAir]s.
 //!
-//! The following modules contain standalone [Air]s:
+//! The following modules contain standalone [Air](openvm_stark_backend::p3_air::Air)s:
 //! - [range]
 //! - [range_gate]
 //! - [range_tuple]

crates/circuits/primitives/src/sub_air.rs

@@ -3,7 +3,7 @@ use openvm_stark_backend::p3_air::AirBuilder;
 /// Trait with associated types intended to allow re-use of constraint logic
 /// inside other AIRs.
 ///
-/// A `SubAir` is **not** an [`Air`](p3_air::Air) itself.
+/// A `SubAir` is **not** an [Air](openvm_stark_backend::p3_air::Air) itself.
 /// A `SubAir` is a struct that holds the means to generate a particular set of constraints,
 /// meant to be re-usable within other AIRs.
 ///

crates/circuits/sha256-air/src/trace.rs

@@ -42,7 +42,7 @@ impl Sha256Air {
     /// and the buffer values that will be put in rows 0..4.
     /// Will populate the given `trace` with the trace of the block, where the width of the trace is `trace_width`
     /// and the starting column for the `Sha256Air` is `trace_start_col`.
-    /// **Note**: this function only generates some of the required trace. Another pass is required, refer to [`generate_missing_cells`] for details.
+    /// **Note**: this function only generates some of the required trace. Another pass is required, refer to [`Self::generate_missing_cells`] for details.
     #[allow(clippy::too_many_arguments)]
     pub fn generate_block_trace<F: PrimeField32>(
         &self,
@@ -285,7 +285,7 @@ impl Sha256Air {
 
     /// This function will fill in the cells that we couldn't do during the first pass.
     /// This function should be called only after `generate_block_trace` was called for all blocks
-    /// And [`generate_default_row`] is called for all invalid rows
+    /// And [`Self::generate_default_row`] is called for all invalid rows
     /// Will populate the missing values of `trace`, where the width of the trace is `trace_width`
     /// and the starting column for the `Sha256Air` is `trace_start_col`.
     /// Note: `trace` needs to be the rows 1..17 of a block and the first row of the next block

crates/sdk/src/commit.rs

@@ -35,7 +35,7 @@ pub struct AppExecutionCommit<T> {
     ///     ),
     ///     hash(right_pad(pc_start, 0))
     /// )
-    /// `right_pad` example, if pc_start = 123, right_pad(pc_start, 0) = [123,0,0,0,0,0,0,0]
+    /// `right_pad` example, if pc_start = 123, right_pad(pc_start, 0) = \[123,0,0,0,0,0,0,0\]
     pub exe_commit: [T; DIGEST_SIZE],
 }
 

crates/sdk/src/verifier/root/types.rs

@@ -25,7 +25,7 @@ pub struct RootVmVerifierPvs<T> {
 
 /// Input for the root VM verifier.
 /// Note: Root verifier is proven in Root SC, but it usually verifies proofs in SC. So
-/// usually only RootVmVerifierInput<SC> is needed.
+/// usually only RootVmVerifierInput\<SC\> is needed.
 #[derive(Serialize, Deserialize, Derivative)]
 #[serde(bound = "")]
 #[derivative(Clone(bound = "Com<SC>: Clone"))]