Update outdated comment about initializers

PartyDAO · Dec 5, 2023 · 4ff9426 · 4ff9426
1 parent d2d01da
commit 4ff9426
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 16 deletions.
diff --git a/contracts/crowdfund/AuctionCrowdfund.sol b/contracts/crowdfund/AuctionCrowdfund.sol
@@ -13,8 +13,7 @@ contract AuctionCrowdfund is AuctionCrowdfundBase {
     // Set the `Globals` contract.
     constructor(IGlobals globals) AuctionCrowdfundBase(globals) {}
 
-    /// @notice Initializer to be delegatecalled by `Proxy` constructor. Will
-    ///         revert if called outside the constructor.
+    /// @notice Initializer to be called prior to using the contract.
     /// @param opts Options used to initialize the crowdfund. These are fixed
     ///             and cannot be changed later.
     function initialize(AuctionCrowdfundOptions memory opts) external payable onlyInitialize {

diff --git a/contracts/crowdfund/AuctionCrowdfundBase.sol b/contracts/crowdfund/AuctionCrowdfundBase.sol
@@ -115,8 +115,7 @@ abstract contract AuctionCrowdfundBase is Crowdfund {
     // Set the `Globals` contract.
     constructor(IGlobals globals) Crowdfund(globals) {}
 
-    /// @notice Initializer to be delegatecalled by `Proxy` constructor. Will
-    ///         revert if called outside the constructor.
+    /// @notice Initializer to be called prior to using the contract.
     /// @param opts Options used to initialize the crowdfund. These are fixed
     ///             and cannot be changed later.
     function _initialize(AuctionCrowdfundOptions memory opts) internal {

diff --git a/contracts/crowdfund/BuyCrowdfund.sol b/contracts/crowdfund/BuyCrowdfund.sol
@@ -74,8 +74,7 @@ contract BuyCrowdfund is BuyCrowdfundBase {
     // Set the `Globals` contract.
     constructor(IGlobals globals) BuyCrowdfundBase(globals) {}
 
-    /// @notice Initializer to be delegatecalled by `Proxy` constructor. Will
-    ///         revert if called outside the constructor.
+    /// @notice Initializer to be called prior to using the contract.
     /// @param opts Options used to initialize the crowdfund. These are fixed
     ///             and cannot be changed later.
     function initialize(BuyCrowdfundOptions memory opts) external payable onlyInitialize {

diff --git a/contracts/crowdfund/CollectionBatchBuyCrowdfund.sol b/contracts/crowdfund/CollectionBatchBuyCrowdfund.sol
@@ -94,8 +94,7 @@ contract CollectionBatchBuyCrowdfund is BuyCrowdfundBase {
     // Set the `Globals` contract.
     constructor(IGlobals globals) BuyCrowdfundBase(globals) {}
 
-    /// @notice Initializer to be delegatecalled by `Proxy` constructor. Will
-    ///         revert if called outside the constructor.
+    /// @notice Initializer to be called prior to using the contract.
     /// @param opts Options used to initialize the crowdfund. These are fixed
     ///             and cannot be changed later.
     function initialize(

diff --git a/contracts/crowdfund/CollectionBuyCrowdfund.sol b/contracts/crowdfund/CollectionBuyCrowdfund.sol
@@ -67,8 +67,7 @@ contract CollectionBuyCrowdfund is BuyCrowdfundBase {
     // Set the `Globals` contract.
     constructor(IGlobals globals) BuyCrowdfundBase(globals) {}
 
-    /// @notice Initializer to be delegatecalled by `Proxy` constructor. Will
-    ///         revert if called outside the constructor.
+    /// @notice Initializer to be called prior to using the contract.
     /// @param opts Options used to initialize the crowdfund. These are fixed
     ///             and cannot be changed later.
     function initialize(CollectionBuyCrowdfundOptions memory opts) external payable onlyInitialize {

diff --git a/contracts/crowdfund/InitialETHCrowdfund.sol b/contracts/crowdfund/InitialETHCrowdfund.sol
@@ -98,8 +98,7 @@ contract InitialETHCrowdfund is ETHCrowdfundBase {
     // Set the `Globals` contract.
     constructor(IGlobals globals) ETHCrowdfundBase(globals) {}
 
-    /// @notice Initializer to be delegatecalled by `Proxy` constructor. Will
-    ///         revert if called outside the constructor.
+    /// @notice Initializer to be called prior to using the contract.
     /// @param crowdfundOpts Options to initialize the crowdfund with.
     /// @param partyOpts Options to initialize the party with.
     /// @param customMetadataProvider Optional provider to use for the party for

diff --git a/contracts/crowdfund/RollingAuctionCrowdfund.sol b/contracts/crowdfund/RollingAuctionCrowdfund.sol
@@ -48,8 +48,7 @@ contract RollingAuctionCrowdfund is AuctionCrowdfundBase {
     // Set the `Globals` contract.
     constructor(IGlobals globals) AuctionCrowdfundBase(globals) {}
 
-    /// @notice Initializer to be delegatecalled by `Proxy` constructor. Will
-    ///         revert if called outside the constructor.
+    /// @notice Initializer to be called prior to using the contract.
     /// @param opts Options used to initialize the crowdfund. These are fixed
     ///             and cannot be changed later.
     /// @param allowedAuctionsMerkleRoot_ Merkle root of list of allowed next

diff --git a/contracts/party/Party.sol b/contracts/party/Party.sol
@@ -33,8 +33,7 @@ contract Party is PartyGovernanceNFT {
     // Set the `Globals` contract.
     constructor(IGlobals globals) PartyGovernanceNFT(globals) {}
 
-    /// @notice Initializer to be delegatecalled by `Proxy` constructor. Will
-    ///         revert if called outside the constructor.
+    /// @notice Initializer to be called prior to using the contract.
     /// @param initData Options used to initialize the party governance.
     function initialize(PartyInitData memory initData) external onlyInitialize {
         PartyGovernanceNFT._initialize(