Commit 4abf2d97 authored by Mark Tyneway's avatar Mark Tyneway

contracts-bedrock: better comment for deployer `name()(string)`

Updates the comment for the `name()(string)` function that is
abstract on the `Deployer` contract. It should be more obvious
why the function exists now.
parent 2aad1783
...@@ -52,8 +52,7 @@ import "src/libraries/DisputeTypes.sol"; ...@@ -52,8 +52,7 @@ import "src/libraries/DisputeTypes.sol";
contract Deploy is Deployer { contract Deploy is Deployer {
DeployConfig cfg; DeployConfig cfg;
/// @notice The name of the script, used to ensure the right deploy artifacts /// @inheritdoc
/// are used.
function name() public pure override returns (string memory name_) { function name() public pure override returns (string memory name_) {
name_ = "Deploy"; name_ = "Deploy";
} }
......
...@@ -163,6 +163,8 @@ abstract contract Deployer is Script { ...@@ -163,6 +163,8 @@ abstract contract Deployer is Script {
/// @notice Returns the name of the deployment script. Children contracts /// @notice Returns the name of the deployment script. Children contracts
/// must implement this to ensure that the deploy artifacts can be found. /// must implement this to ensure that the deploy artifacts can be found.
/// This should be the same as the name of the script and is used as the file
/// name inside of the `broadcast` directory when looking up deployment artifacts.
function name() public pure virtual returns (string memory); function name() public pure virtual returns (string memory);
/// @notice Returns all of the deployments done in the current context. /// @notice Returns all of the deployments done in the current context.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment