From 4d4edb8142ea35236988a74879a7cc18bb57b7fb Mon Sep 17 00:00:00 2001 From: Kellar Date: Mon, 28 Oct 2024 13:04:24 +0000 Subject: [PATCH] Put natspec update in the correct contract --- contracts/DecentHats.sol | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/contracts/DecentHats.sol b/contracts/DecentHats.sol index 0ce8374..7660c33 100644 --- a/contracts/DecentHats.sol +++ b/contracts/DecentHats.sol @@ -87,10 +87,10 @@ contract DecentHats { EXTERNAL FUNCTIONS ///////////////////////////////////////////////////////////////////////////// */ /** - * For a safe without any roles previously created on it, this function should be called. It sets up the + * @notice For a safe without any roles previously created on it, this function should be called. It sets up the * top hat and admin hat, as well as any other hats and their streams that are provided. * - * This contract should be enabled a module on the Safe for which the role(s) are to be created, and disabled after. + * @notice This contract should be enabled a module on the Safe for which the role(s) are to be created, and disabled after. * * @dev In order for a Safe to seamlessly create roles even if it has never previously created a role and thus has * no hat tree, we defer the creation of the hat tree and its setup to this contract. This way, in a single tx block, @@ -155,14 +155,14 @@ contract DecentHats { } /** - * Creates a new role hat and any streams on it. + * @notice Creates a new role hat and any streams on it. * - * This contract should be enabled a module on the Safe for which the role is to be created, and disable after. - * In order for the module to be able to create hats on behalf of the Safe, the Safe must first - * transfer its top hat to this contract. This function transfers the top hat back to the Safe after + * @notice This contract should be enabled a module on the Safe for which the role is to be created, and disabled after. + * + * @dev In order for the module to be able to create hats on behalf of the Safe, the Safe must first transfer its top hat to this contract. This function transfers the top hat back to the Safe after * creating the role hat. * - * The function simply calls `createHatAndAccountAndMintAndStreams` and then transfers the top hat back to the Safe. + * @dev The function simply calls `createHatAndAccountAndMintAndStreams` and then transfers the top hat back to the Safe. * * @dev Role hat creation, minting, smart account creation and stream creation are handled here in order * to avoid a race condition where not more than one active proposal to create a new role can exist at a time.