From 97041569b91e6063821f7acef25bda42a8e3e601 Mon Sep 17 00:00:00 2001 From: Victoria Date: Tue, 14 Nov 2023 16:13:06 +0200 Subject: [PATCH] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: David Núñez Co-authored-by: Derek Pierre --- contracts/staking/IApplicationWithDecreaseDelay.sol | 8 ++++---- contracts/staking/IApplicationWithOperator.sol | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/contracts/staking/IApplicationWithDecreaseDelay.sol b/contracts/staking/IApplicationWithDecreaseDelay.sol index d5d2ddf1..03ecc370 100644 --- a/contracts/staking/IApplicationWithDecreaseDelay.sol +++ b/contracts/staking/IApplicationWithDecreaseDelay.sol @@ -26,15 +26,15 @@ interface IApplicationWithDecreaseDelay is IApplication { /// so that operator can participate in the application. /// @return authorizationDecreaseDelay Delay in seconds that needs to pass /// between the time authorization decrease is requested and the - /// time that request gets approved. Protects against free-riders + /// time that request gets approved. Protects against participants /// earning rewards and not being active in the network. /// @return authorizationDecreaseChangePeriod Authorization decrease change - /// period in seconds. It is the time, before authorization decrease - /// delay end, during which the pending authorization decrease + /// period in seconds. It is the time window, before authorization decrease + /// delay ends, during which the pending authorization decrease /// request can be overwritten. /// If set to 0, pending authorization decrease request can not be /// overwritten until the entire `authorizationDecreaseDelay` ends. - /// If set to value equal `authorizationDecreaseDelay`, request can + /// If set to a value equal to `authorizationDecreaseDelay`, request can /// always be overwritten. function authorizationParameters() external diff --git a/contracts/staking/IApplicationWithOperator.sol b/contracts/staking/IApplicationWithOperator.sol index 602c39b1..6750194e 100644 --- a/contracts/staking/IApplicationWithOperator.sol +++ b/contracts/staking/IApplicationWithOperator.sol @@ -26,11 +26,11 @@ interface IApplicationWithOperator is IApplication { returns (address); /// @notice Used by staking provider to set operator address that will - /// operate a node. The operator addressmust be unique. + /// operate a node. The operator address must be unique. /// Reverts if the operator is already set for the staking provider /// or if the operator address is already in use. /// @dev Depending on application the given staking provider can set operator - /// address only one or multiple times. Besides that application can decide + /// address only once or multiple times. Besides that, application can decide /// if function reverts if there is a pending authorization decrease for /// the staking provider. function registerOperator(address operator) external;