Skip to content

Commit

Permalink
docs: fix natspecs related to snapshots
Browse files Browse the repository at this point in the history
  • Loading branch information
smol-ninja committed Oct 25, 2024
1 parent 6786126 commit 9d07774
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions src/interfaces/ISablierFlow.sol
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ interface ISablierFlow is
/// @dev Emits {AdjustFlowStream} and {MetadataUpdate} events.
///
/// Notes:
/// - Performs a debt snapshot.
/// - It updates snapshot debt and snapshot time.
///
/// Requirements:
/// - Must not be delegate called.
Expand Down Expand Up @@ -301,8 +301,7 @@ interface ISablierFlow is
/// @dev Emits {PauseFlowStream} event.
///
/// Notes:
/// - It does not set the snapshot time to the current block timestamp.
/// - It updates the snapshot debt by adding up ongoing debt.
/// - It updates snapshot debt and snapshot time.
/// - It sets the rate per second to zero.
///
/// Requirements:
Expand Down Expand Up @@ -344,10 +343,9 @@ interface ISablierFlow is
/// @notice Restarts the stream with the provided rate per second.
///
/// @dev Emits {RestartFlowStream} event.
/// - This function updates stream's `snapshotTime` to the current block timestamp.
///
/// Notes:
/// - It sets the snapshot time to the current block timestamp.
/// - It updates snapshot debt and snapshot time.
///
/// Requirements:
/// - Must not be delegate called.
Expand Down

0 comments on commit 9d07774

Please sign in to comment.