Fix docs warnings

Sovereign-Labs · Jul 19, 2023 · 709017d · 709017d
1 parent dd4b7d3
commit 709017d
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/adapters/celestia/src/share_commit.rs b/adapters/celestia/src/share_commit.rs
@@ -28,7 +28,7 @@ impl std::fmt::Display for CommitmentError {
 
 impl std::error::Error for CommitmentError {}
 
-/// Derived from https://github.com/celestiaorg/celestia-app/blob/0c81704939cd743937aac2859f3cb5ae6368f174/x/payment/types/payfordata.go#L170
+/// Derived from <https://github.com/celestiaorg/celestia-app/blob/0c81704939cd743937aac2859f3cb5ae6368f174/x/payment/types/payfordata.go#L170>
 pub fn recreate_commitment(
     square_size: usize,
     shares: shares::BlobRef,

diff --git a/rollup-interface/src/node/services/stf_runner.rs b/rollup-interface/src/node/services/stf_runner.rs
@@ -23,7 +23,7 @@ use crate::zk::Zkvm;
 ///
 /// and a `impl StateTransitionRunner<ZkConfig, Vm> for MyRunner` which instead uses a state root as its runtime config.
 ///
-/// TODO: Why is it called runner? It only creates. Creator, Factory: https://github.com/Sovereign-Labs/sovereign-sdk/issues/447
+/// TODO: Why is it called runner? It only creates. Creator, Factory: <https://github.com/Sovereign-Labs/sovereign-sdk/issues/447>
 pub trait StateTransitionRunner<T: StateTransitionConfig, Vm: Zkvm, B: BlobTransactionTrait> {
     /// The parameters of the state transition function which are set at runtime. For example,
     /// the runtime config might contain path to a data directory.

diff --git a/rollup-interface/src/state_machine/crypto/simple_hasher.rs b/rollup-interface/src/state_machine/crypto/simple_hasher.rs
@@ -1,6 +1,6 @@
 pub use jmt::SimpleHasher;
 
-/// A SimpleHasher implementation which always returns the digest [0;32]
+/// A SimpleHasher implementation which always returns the digest `[0;32]`
 pub struct NoOpHasher;
 
 impl SimpleHasher for NoOpHasher {

diff --git a/rollup-interface/src/state_machine/da.rs b/rollup-interface/src/state_machine/da.rs
@@ -103,7 +103,7 @@ impl<B: Buf> CountedBufReader<B> {
     }
 
     /// Getter: returns a reference to an accumulator of the blob data read by the rollup
-    /// TODO: Refactor https://github.com/Sovereign-Labs/sovereign-sdk/issues/462
+    /// TODO: Refactor <https://github.com/Sovereign-Labs/sovereign-sdk/issues/462>
     pub fn acc(&self) -> &Vec<u8> {
         &self.reading_acc
     }