chore: enable format_code_in_doc_comments for rustfmt (#467)

tangle-network · Nov 12, 2024 · 2c27ee6 · 2c27ee6
1 parent 7221994
commit 2c27ee6
Show file tree

Hide file tree

Showing 3 changed files with 1 addition and 7 deletions.
diff --git a/blueprint-test-utils/src/lib.rs b/blueprint-test-utils/src/lib.rs
@@ -218,7 +218,6 @@ pub async fn inject_test_keys<P: AsRef<Path>>(
 /// # Errors
 /// - Fails if the given index is out of bounds
 /// - May fail if the keystore path cannot be created or accessed
-///
 fn inject_anvil_key<P: AsRef<Path>>(keystore_path: P, seed: &str) -> color_eyre::Result<()> {
     let keystore = GenericKeyStore::<parking_lot::RawRwLock>::Fs(FilesystemKeystore::open(
         keystore_path.as_ref(),
@@ -257,7 +256,6 @@ fn inject_anvil_key<P: AsRef<Path>>(keystore_path: P, seed: &str) -> color_eyre:
 /// # Errors
 /// - Fails if the given index is out of bounds
 /// - May fail if the keystore path cannot be created or accessed
-///
 fn inject_tangle_key<P: AsRef<Path>>(keystore_path: P, name: &str) -> color_eyre::Result<()> {
     let keystore = GenericKeyStore::<parking_lot::RawRwLock>::Fs(FilesystemKeystore::open(
         keystore_path.as_ref(),
@@ -348,7 +346,6 @@ fn inject_tangle_key<P: AsRef<Path>>(keystore_path: P, name: &str) -> color_eyre
 ///
 /// # Errors
 /// - May fail if the keystore path cannot be created or accessed
-///
 pub fn inject_random_key<P: AsRef<Path>>(keystore_path: P) -> color_eyre::Result<()> {
     let keystore = GenericKeyStore::<parking_lot::RawRwLock>::Fs(FilesystemKeystore::open(
         keystore_path.as_ref(),

diff --git a/rustfmt.toml b/rustfmt.toml
@@ -0,0 +1 @@
+format_code_in_doc_comments = true
diff --git a/sdk/src/utils/evm.rs b/sdk/src/utils/evm.rs
@@ -11,7 +11,6 @@ pub const SIGNATURE_EXPIRY: U256 = U256::from_limbs([86400, 0, 0, 0]);
 ///
 /// # Returns
 /// - [`RootProvider<BoxTransport>`] - The provider
-///
 pub fn get_provider_http(http_endpoint: &str) -> RootProvider<BoxTransport> {
     let provider = ProviderBuilder::new()
         .with_recommended_fillers()
@@ -27,7 +26,6 @@ pub fn get_provider_http(http_endpoint: &str) -> RootProvider<BoxTransport> {
 ///
 /// # Returns
 /// - [`RootProvider<BoxTransport>`] - The provider
-///
 pub fn get_wallet_provider_http(
     http_endpoint: &str,
     wallet: EthereumWallet,
@@ -47,7 +45,6 @@ pub fn get_wallet_provider_http(
 ///
 /// # Returns
 /// - [`RootProvider<BoxTransport>`] - The provider
-///
 pub async fn get_provider_ws(ws_endpoint: &str) -> RootProvider<BoxTransport> {
     let provider = ProviderBuilder::new()
         .with_recommended_fillers()
@@ -68,7 +65,6 @@ pub async fn get_provider_ws(ws_endpoint: &str) -> RootProvider<BoxTransport> {
 ///
 /// # Errors
 /// - [`Error::AlloyContract`] - If the call to the contract fails (i.e. the contract doesn't exist at the given address)
-///
 pub async fn get_slasher_address(
     delegation_manager_addr: Address,
     http_endpoint: &str,