docs: propose natspec

defi-wonderland · Nov 16, 2023 · bfc2706 · bfc2706
1 parent fb2b9a2
commit bfc2706
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/solidity/interfaces/modules/response/IResponseModule.sol b/solidity/interfaces/modules/response/IResponseModule.sol
@@ -9,9 +9,12 @@ import {IOracle} from '../../IOracle.sol';
  * @notice Common interface for all response modules
  */
 interface IResponseModule is IModule {
-  // TODO: natspec
   /**
    * @notice Creates a new response for a given request
+   *
+   * @param _request The request to create a response for
+   * @param _response The response to create
+   * @param _sender The creator of the response
    */
   function propose(IOracle.Request calldata _request, IOracle.Response calldata _response, address _sender) external;
 }