addresses comment about file docstrings new format

see #399 (comment)
bancorprotocol · Mar 28, 2024 · 6af6e38 · 6af6e38
1 parent f982cb0
commit 6af6e38
Show file tree

Hide file tree

Showing 10 changed files with 24 additions and 4 deletions.
diff --git a/fastlane_bot/tests/deterministic/dtest_cmd_line_args.py b/fastlane_bot/tests/deterministic/dtest_cmd_line_args.py
@@ -1,3 +1,10 @@
+"""
+This file contains the TestCommandLineArgs class, which is a dataclass that represents the command-line arguments for the main.py.
+
+(c) Copyright Bprotocol foundation 2024.
+All rights reserved.
+Licensed under MIT License.
+"""
 from dataclasses import dataclass
 
 from fastlane_bot.tools.cpc import T

diff --git a/fastlane_bot/tests/deterministic/dtest_constants.py b/fastlane_bot/tests/deterministic/dtest_constants.py
@@ -2,6 +2,7 @@
 This file contains constants used in the deterministic tests.
 
 (c) Copyright Bprotocol foundation 2024.
+All rights reserved.
 Licensed under MIT License.
 """
 

diff --git a/fastlane_bot/tests/deterministic/dtest_main.py b/fastlane_bot/tests/deterministic/dtest_main.py
@@ -1,14 +1,19 @@
+"""This file contains the main function for the deterministic tests. Used to run the specified task based on the
+command line arguments defined in `run_deterministic_tests.py`.
+
+(c) Copyright Bprotocol foundation 2024.
+All rights reserved.
+Licensed under MIT License.
+"""
 import argparse
 import logging
 import os
 import subprocess
 import time
 from typing import Dict
 
-from web3 import Web3
-
-from fastlane_bot.tests.deterministic.dtest_constants import KNOWN_UNABLE_TO_DELETE
 from fastlane_bot.tests.deterministic.dtest_cmd_line_args import TestCommandLineArgs
+from fastlane_bot.tests.deterministic.dtest_constants import KNOWN_UNABLE_TO_DELETE
 from fastlane_bot.tests.deterministic.dtest_manager import TestManager
 from fastlane_bot.tests.deterministic.dtest_pool import TestPool
 from fastlane_bot.tests.deterministic.dtest_pool_params_builder import TestPoolParamsBuilder

diff --git a/fastlane_bot/tests/deterministic/dtest_manager.py b/fastlane_bot/tests/deterministic/dtest_manager.py
@@ -2,6 +2,7 @@
 A module to manage Carbon strategies.
 
 (c) Copyright Bprotocol foundation 2024.
+All rights reserved.
 Licensed under MIT License.
 """
 import argparse
@@ -39,7 +40,7 @@ class TestManager:
     """
 
     def __init__(self, args: argparse.Namespace):
-        
+
         self.w3 = Web3(Web3.HTTPProvider(args.rpc_url, {"timeout": 60}))
         assert self.w3.is_connected(), "Web3 connection failed"
 

diff --git a/fastlane_bot/tests/deterministic/dtest_pool.py b/fastlane_bot/tests/deterministic/dtest_pool.py
@@ -2,6 +2,7 @@
 This module contains the Wallet class, which is a dataclass that represents a wallet on the given network.
 
 (c) Copyright Bprotocol foundation 2024.
+All rights reserved.
 Licensed under MIT License.
 """
 import argparse

diff --git a/fastlane_bot/tests/deterministic/dtest_pool_params_builder.py b/fastlane_bot/tests/deterministic/dtest_pool_params_builder.py
@@ -3,6 +3,7 @@
 encode them into a string that can be used to update the storage of the pool contract.
 
 (c) Copyright Bprotocol foundation 2024.
+All rights reserved.
 Licensed under MIT License.
 """
 import re

diff --git a/fastlane_bot/tests/deterministic/dtest_strategy.py b/fastlane_bot/tests/deterministic/dtest_strategy.py
@@ -2,6 +2,7 @@
 This file contains the Strategy class, which is used to represent a strategy in the deterministic tests.
 
 (c) Copyright Bprotocol foundation 2024.
+All rights reserved.
 Licensed under MIT License.
 """
 import argparse

diff --git a/fastlane_bot/tests/deterministic/dtest_token.py b/fastlane_bot/tests/deterministic/dtest_token.py
@@ -2,6 +2,7 @@
 Token class to store token address and contract object for interacting with the token on the blockchain.
 
 (c) Copyright Bprotocol foundation 2024.
+All rights reserved.
 Licensed under MIT License.
 """
 from dataclasses import dataclass

diff --git a/fastlane_bot/tests/deterministic/dtest_tx_helper.py b/fastlane_bot/tests/deterministic/dtest_tx_helper.py
@@ -3,6 +3,7 @@
 and clean and extract the transaction data.
 
 (c) Copyright Bprotocol foundation 2024.
+All rights reserved.
 Licensed under MIT License.
 """
 import argparse

diff --git a/fastlane_bot/tests/deterministic/dtest_wallet.py b/fastlane_bot/tests/deterministic/dtest_wallet.py
@@ -2,6 +2,7 @@
 This module contains the Wallet class, which is a dataclass that represents a wallet on the Ethereum network.
 
 (c) Copyright Bprotocol foundation 2024.
+All rights reserved.
 Licensed under MIT License.
 """
 from dataclasses import dataclass