From bfc2706d44cb5c666006778c8e9489864ac4ab32 Mon Sep 17 00:00:00 2001 From: Gas One Cent <86567384+gas1cent@users.noreply.github.com> Date: Thu, 16 Nov 2023 23:15:57 +0300 Subject: [PATCH] docs: `propose` natspec --- solidity/interfaces/modules/response/IResponseModule.sol | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/solidity/interfaces/modules/response/IResponseModule.sol b/solidity/interfaces/modules/response/IResponseModule.sol index 8dcadef..47e5f13 100644 --- 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; }