Skip to content

Commit cb4e272

Browse files
authored
docs: minor improvement for docs (sablier-labs#1329)
Signed-off-by: ledigang <shuangcui@msn.com>
1 parent 893eabb commit cb4e272

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

flow/src/SablierFlow.sol

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -466,7 +466,7 @@ contract SablierFlow is
466466

467467
/// @inheritdoc ISablierFlow
468468
function setNativeToken(address newNativeToken) external override onlyComptroller {
469-
// Check: provided token is not zero address.
469+
// Check: provided token is not the zero address.
470470
if (newNativeToken == address(0)) {
471471
revert Errors.SablierFlow_NativeTokenZeroAddress();
472472
}
@@ -571,7 +571,7 @@ contract SablierFlow is
571571
INTERNAL STATE-CHANGING FUNCTIONS
572572
//////////////////////////////////////////////////////////////////////////*/
573573

574-
/// @notice Overrides the {ERC-721._update} function to check that the stream is transferable.
574+
/// @notice Overrides the {ERC721._update} function to check that the stream is transferable.
575575
///
576576
/// @dev The transferable flag is ignored if the current owner is 0, as the update in this case is a mint and
577577
/// is allowed. Transfers to the zero address are not allowed, preventing accidental burns.

flow/src/interfaces/ISablierFlow.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -441,7 +441,7 @@ interface ISablierFlow is
441441
///
442442
/// Requirements:
443443
/// - `msg.sender` must be the comptroller contract.
444-
/// - `newNativeToken` must not be zero address.
444+
/// - `newNativeToken` must not be the zero address.
445445
/// - The native token must not be already set.
446446
/// @param newNativeToken The address of the native token.
447447
function setNativeToken(address newNativeToken) external;

lockup/src/SablierLockup.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -529,7 +529,7 @@ contract SablierLockup is
529529
token.safeTransferFrom({ from: msg.sender, to: address(this), value: depositAmount });
530530
}
531531

532-
/// @notice Overrides the {ERC-721._update} function to check that the stream is transferable, and emits an
532+
/// @notice Overrides the {ERC721._update} function to check that the stream is transferable, and emits an
533533
/// ERC-4906 event.
534534
/// @dev There are two cases when the transferable flag is ignored:
535535
/// - If the current owner is 0, then the update is a mint and is allowed.

lockup/src/interfaces/ISablierLockup.sol

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ interface ISablierLockup is
173173
/// @dev Emits a {Transfer}, {CancelLockupStream} and {MetadataUpdate} event.
174174
///
175175
/// Notes:
176-
/// - If there any tokens left for the recipient to withdraw, the stream is marked as canceled. Otherwise, the
176+
/// - If there are any tokens left for the recipient to withdraw, the stream is marked as canceled. Otherwise, the
177177
/// stream is marked as depleted.
178178
/// - If the address is on the allowlist, this function will invoke a hook on the recipient.
179179
///
@@ -234,11 +234,11 @@ interface ISablierLockup is
234234
/// @dev For more information, see the documentation for {nativeToken}.
235235
///
236236
/// Notes:
237-
/// - If `newNativeToken` is zero address, the function does not revert.
237+
/// - If `newNativeToken` is the zero address, the function does not revert.
238238
///
239239
/// Requirements:
240240
/// - `msg.sender` must be the comptroller contract.
241-
/// - The current native token must be zero address.
241+
/// - The current native token must be the zero address.
242242
/// @param newNativeToken The address of the native token.
243243
function setNativeToken(address newNativeToken) external;
244244

0 commit comments

Comments
 (0)