docs: include a warning note for statusOf (#363)

* docs: include a warning note for statusOf * docs: polish --------- Co-authored-by: Paul Razvan Berg <[email protected]>
sablier-labs · Jan 7, 2025 · 32ac99c · 32ac99c
1 parent 0fdd65a
commit 32ac99c
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/interfaces/ISablierFlow.sol b/src/interfaces/ISablierFlow.sol
@@ -138,6 +138,8 @@ interface ISablierFlow is
 
     /// @notice Returns the stream's status.
     /// @dev Reverts if `streamId` references a null stream.
+    /// Integrators should exercise caution when depending on the return value of this function as streams can be paused
+    /// and resumed at any moment.
     /// @param streamId The stream ID for the query.
     function statusOf(uint256 streamId) external view returns (Flow.Status status);