docs: add a comment about the previous name of a function

cloudwalk · Aug 29, 2024 · d6fc8f6 · d6fc8f6
1 parent b21d81c
commit d6fc8f6
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/contracts/base/ERC20Freezable.sol b/contracts/base/ERC20Freezable.sol
@@ -77,6 +77,7 @@ abstract contract ERC20Freezable is ERC20Base, IERC20Freezable {
      * @dev The contract must not be paused
      * @dev Can only be called by the owner
      * @dev Each freezer from the array must not be already have the provided status
+     * @dev NOTE: The previous function name was: `configureFreezers()`
      */
     function configureFreezerBatch(
         address[] calldata freezers, // Tools: this comment prevents Prettier from formatting into a single line.

diff --git a/contracts/base/interfaces/IERC20Freezable.sol b/contracts/base/interfaces/IERC20Freezable.sol
@@ -53,6 +53,8 @@ interface IERC20Freezable {
      *
      * Emits a {FreezerRemoved} event for each removed freezer
      *
+     * NOTE: The previous function name was: `configureFreezers()`
+     *
      * @param freezers The array of freezer addresses to configure
      * @param status The new status of the freezers: `true` is to assign freezers, `false` is to remove freezers
      */