docs: improve wording in NatSpec code comments

sablier-labs · Feb 13, 2023 · 0e19ff1 · 0e19ff1
1 parent 0437313
commit 0e19ff1
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git 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
@@ -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: