chore: clean up comments (#211)

erc6900 · Dec 5, 2024 · c9b256c · c9b256c
1 parent 7284028
commit c9b256c
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 12 deletions.
diff --git a/src/interfaces/IExecutionHookModule.sol b/src/interfaces/IExecutionHookModule.sol
@@ -10,7 +10,8 @@ interface IExecutionHookModule is IModule {
     /// be more than one.
     /// @param sender The caller address.
     /// @param value The call value.
-    /// @param data The calldata sent. For `executeUserOp` calls, hook modules should receive the full msg.data.
+    /// @param data The calldata sent. For `executeUserOp` calls of validation-associated hooks, hook modules
+    /// should receive the full calldata.
     /// @return Context to pass to a post execution hook, if present. An empty bytes array MAY be returned.
     function preExecutionHook(uint32 entityId, address sender, uint256 value, bytes calldata data)
         external

diff --git a/src/interfaces/IExecutionModule.sol b/src/interfaces/IExecutionModule.sol
@@ -4,7 +4,7 @@ pragma solidity ^0.8.20;
 import {IModule} from "./IModule.sol";
 
 struct ManifestExecutionFunction {
-    // The selector to install
+    // The selector to install.
     bytes4 executionSelector;
     // If true, the function won't need runtime validation, and can be called by anyone.
     bool skipRuntimeValidation;

diff --git a/src/interfaces/IModularAccount.sol b/src/interfaces/IModularAccount.sol
@@ -80,14 +80,13 @@ interface IModularAccount {
     /// @param module The module to install.
     /// @param manifest the manifest describing functions to install.
     /// @param installData Optional data to be used by the account to handle the initial execution setup. Data
-    /// encoding
-    /// is implementation-specific.
+    /// encoding is implementation-specific.
     function installExecution(address module, ExecutionManifest calldata manifest, bytes calldata installData)
         external;
 
     /// @notice Uninstall a module from the modular account.
     /// @param module The module to uninstall.
-    /// @param manifest the manifest describing functions to uninstall.
+    /// @param manifest The manifest describing functions to uninstall.
     /// @param uninstallData Optional data to be used by the account to handle the execution uninstallation. Data
     /// encoding is implementation-specific.
     function uninstallExecution(address module, ExecutionManifest calldata manifest, bytes calldata uninstallData)
@@ -113,8 +112,7 @@ interface IModularAccount {
     /// @param uninstallData Optional data to be used by the account to handle the validation uninstallation. Data
     /// encoding is implementation-specific.
     /// @param hookUninstallData Optional data to be used by the account to handle hook uninstallation. Data
-    /// encoding
-    /// is implementation-specific.
+    /// encoding is implementation-specific.
     function uninstallValidation(
         ModuleEntity validationFunction,
         bytes calldata uninstallData,

diff --git a/src/interfaces/IValidationModule.sol b/src/interfaces/IValidationModule.sol
@@ -18,7 +18,7 @@ interface IValidationModule is IModule {
 
     /// @notice Run the runtime validation function specified by the `entityId`.
     /// @dev To indicate the entire call should revert, the function MUST revert.
-    /// @param account the account to validate for.
+    /// @param account The account to validate for.
     /// @param entityId An identifier that routes the call to different internal implementations, should there
     /// be more than one.
     /// @param sender The caller address.
@@ -36,12 +36,12 @@ interface IValidationModule is IModule {
 
     /// @notice Validates a signature using ERC-1271.
     /// @dev To indicate the entire call should revert, the function MUST revert.
-    /// @param account the account to validate for.
+    /// @param account The account to validate for.
     /// @param entityId An identifier that routes the call to different internal implementations, should there
     /// be more than one.
-    /// @param sender the address that sent the ERC-1271 request to the smart account
-    /// @param hash the hash of the ERC-1271 request
-    /// @param signature the signature of the ERC-1271 request
+    /// @param sender The address that sent the ERC-1271 request to the smart account.
+    /// @param hash The hash of the ERC-1271 request.
+    /// @param signature The signature of the ERC-1271 request.
     /// @return The ERC-1271 `MAGIC_VALUE` if the signature is valid, or 0xFFFFFFFF if invalid.
     function validateSignature(
         address account,