From 0e19ff11ca761bdff3eb351615e5b6177b07e9ca Mon Sep 17 00:00:00 2001 From: Paul Razvan Berg Date: Sun, 12 Feb 2023 16:27:57 +0200 Subject: [PATCH] docs: improve wording in NatSpec code comments --- src/interfaces/ISablierV2Config.sol | 2 +- src/interfaces/ISablierV2Lockup.sol | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/interfaces/ISablierV2Config.sol b/src/interfaces/ISablierV2Config.sol index b88a94abc..41d4ff91e 100644 --- a/src/interfaces/ISablierV2Config.sol +++ b/src/interfaces/ISablierV2Config.sol @@ -47,7 +47,7 @@ interface ISablierV2Config is ISablierV2Adminable { /// @dev Emits a {SetComptroller} event. /// /// Notes: - /// - It is not an error to set the same comptroller. + /// - Does not revert if the comptroller is the same. /// /// Requirements: /// - The caller must be the contract admin. diff --git a/src/interfaces/ISablierV2Lockup.sol b/src/interfaces/ISablierV2Lockup.sol index 4bef98905..b5786dcda 100644 --- a/src/interfaces/ISablierV2Lockup.sol +++ b/src/interfaces/ISablierV2Lockup.sol @@ -116,8 +116,8 @@ interface ISablierV2Lockup is /// @dev Emits multiple {CancelLockupStream} events. /// /// Notes: - /// - It is not an error if one of the stream ids points to a stream that is not active or is active but - /// is not cancelable. + /// - Does not revert if one of the stream ids points to a stream that is not active or is active but is + /// not cancelable. /// - This function will attempt to call a hook on either the sender or the recipient of each stream. /// /// Requirements: @@ -187,7 +187,7 @@ interface ISablierV2Lockup is /// @dev Emits multiple {WithdrawFromLockupStream} and {Transfer} events. /// /// Notes: - /// - It is not an error if one of the stream ids points to a stream that is not active. + /// - Does not revert if one of the stream ids points to a stream that is not active. /// - This function will attempt to call a hook on the recipient of each stream. /// /// Requirements: