fix docstrings

ethereum/light-client/src/bin/client.rs

@@ -41,13 +41,13 @@ pub const ALL_PAIRS_STORAGE_KEY: &str =
 struct Cli {
     /// The address of the checkpoint service provider.
     ///
-    /// See https://eth-clients.github.io/checkpoint-sync-endpoints
+    /// See <https://eth-clients.github.io/checkpoint-sync-endpoints>
     #[arg(short, long)]
     checkpoint_provider_address: String,
 
     /// The address for the beacon node API.
     ///
-    /// It is recommended to use https://www.lightclientdata.org
+    /// It is recommended to use <https://www.lightclientdata.org>
     #[arg(short, long)]
     beacon_node_address: String,
 

ethereum/light-client/src/client/storage.rs

@@ -11,7 +11,7 @@
 //! ## Storage provider address
 //!
 //! The storage client expects an address that contains an API key, which identifies an account at
-//! those RPC partners (e.g.:https://mainnet.infura.io/v3/YOUR-API-KEY). The API key is used to
+//! those RPC partners (e.g.: <https://mainnet.infura.io/v3/YOUR-API-KEY>). The API key is used to
 //! authenticate the client with the RPC provider.
 
 use crate::client::error::ClientError;

ethereum/light-client/src/types/network.rs

@@ -20,7 +20,7 @@ impl Request {
     ///
     /// # Returns
     ///
-    /// A Vec<u8> representing the enum.
+    /// A `Vec<u8>` representing the enum.
     pub fn to_bytes(&self) -> Result<Vec<u8>, Error> {
         match self {
             Request::ProveCommitteeChange(boxed) => {

kadena/core/src/types/header/chain.rs

@@ -243,7 +243,7 @@ impl KadenaHeaderRaw {
     ///
     /// # Notes
     ///
-    /// When the  chain graph degree changes along with the [`crate::types::graph::TWENTY_CHAIN_GRAPH_DEGREE`]
+    /// When the  chain graph degree changes along with the [`crate::types::graph::CHAIN_GRAPH`]
     /// constant this method should be updated.
     pub fn header_root(&self) -> Result<HashValue, CryptoError> {
         let mut adjacent_hashes: Vec<[u8; 32]> = Vec::with_capacity(GRAPH_DEGREE);

kadena/light-client/src/types/network.rs

@@ -25,7 +25,7 @@ impl Request {
     ///
     /// # Returns
     ///
-    /// A Vec<u8> representing the enum.
+    /// A `Vec<u8>` representing the enum.
     pub fn to_bytes(&self) -> Result<Vec<u8>, Error> {
         match self {
             Request::ProveLongestChain(boxed) => {