docs: polish explanatory comment

docs: move Access Control table in TECHNICAL DOC
sablier-labs · Oct 7, 2024 · 244a342 · 244a342
1 parent 6b941ae
commit 244a342
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 14 deletions.
diff --git a/DIAGRAMS.md b/DIAGRAMS.md
@@ -124,19 +124,6 @@ flowchart LR
     linkStyle 2,3,4,10,11 stroke:#ff0000,stroke-width:2px
 ```
 
-## Access Control
-
-| Action              |         Sender         | Recipient | Operator(s) |      Unknown User      |
-| ------------------- | :--------------------: | :-------: | :---------: | :--------------------: |
-| AdjustRatePerSecond |           ✅           |    ❌     |     ❌      |           ❌           |
-| Deposit             |           ✅           |    ✅     |     ✅      |           ✅           |
-| Pause               |           ✅           |    ❌     |     ❌      |           ❌           |
-| Refund              |           ✅           |    ❌     |     ❌      |           ❌           |
-| Restart             |           ✅           |    ❌     |     ❌      |           ❌           |
-| Transfer NFT        |           ❌           |    ✅     |     ✅      |           ❌           |
-| Void                |           ✅           |    ✅     |     ✅      |           ❌           |
-| Withdraw            | ✅ (only to Recipient) |    ✅     |     ✅      | ✅ (only to Recipient) |
-
 ### Internal State
 
 The

diff --git a/TECHNICAL-DOC.md b/TECHNICAL-DOC.md
@@ -38,6 +38,19 @@ can only withdraw the available balance.
 | Total Debt                  | td            |
 | Uncovered Debt              | ud            |
 
+## Access Control
+
+| Action              |         Sender         | Recipient | Operator(s) |      Unknown User      |
+| ------------------- | :--------------------: | :-------: | :---------: | :--------------------: |
+| AdjustRatePerSecond |           ✅           |    ❌     |     ❌      |           ❌           |
+| Deposit             |           ✅           |    ✅     |     ✅      |           ✅           |
+| Pause               |           ✅           |    ❌     |     ❌      |           ❌           |
+| Refund              |           ✅           |    ❌     |     ❌      |           ❌           |
+| Restart             |           ✅           |    ❌     |     ❌      |           ❌           |
+| Transfer NFT        |           ❌           |    ✅     |     ✅      |           ❌           |
+| Void                |           ✅           |    ✅     |     ✅      |           ❌           |
+| Withdraw            | ✅ (only to Recipient) |    ✅     |     ✅      | ✅ (only to Recipient) |
+
 ## Invariants
 
 1. for any stream, $st \le now$

diff --git a/src/SablierFlow.sol b/src/SablierFlow.sol
@@ -71,7 +71,7 @@ contract SablierFlow is
 
         uint128 snapshotDebt = _streams[streamId].snapshotDebt;
 
-        // If the stream has debt, return zero.
+        // If the stream has uncovered debt, return zero.
         if (snapshotDebt + _ongoingDebtOf(streamId) >= balance) {
             return 0;
         }