Skip to content

Commit ea11e7f

Browse files
committed
Add edge case
1 parent e0195e1 commit ea11e7f

File tree

5 files changed

+8
-5
lines changed

5 files changed

+8
-5
lines changed

examples/contracts/Bar.sol

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ contract Bar is IBar {
4040
function set(T memory t) external { }
4141

4242
/// @notice Cool function bro
43-
/// @custom:requirement Check this requirement
43+
/// @custom:requirement Check first requirement
44+
/// @custom:requirement Check second requirement
4445
function boop(uint256 bar) external { }
4546

4647
/// @notice Alt cool function bro

examples/docs/Bar.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@
2525
}
2626
},
2727
"outputs": {},
28-
"notice": "Cool function bro"
28+
"notice": "Cool function bro",
29+
"custom:requirement": "Check first requirementCheck second requirement"
2930
},
3031
"boop(uint256,uint256)": {
3132
"stateMutability": "nonpayable",

examples/docs/Bar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ function boop(uint256 bar) external nonpayable
3737

3838
Cool function bro
3939

40-
40+
**Requirement:** *Check first requirementCheck second requirement*
4141

4242

4343

examples/docs/IBar.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@
3232
}
3333
},
3434
"notice": "Emitted when transfer",
35-
"details": "Transfer some stuff"
35+
"details": "Transfer some stuff",
36+
"custom:danger": "This event exposes private info"
3637
}
3738
},
3839
"errors": {

examples/docs/IBar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ event Transfer(uint256 foo)
5959
Emitted when transfer
6060
*Transfer some stuff*
6161

62-
62+
**Danger:** *This event exposes private info*
6363

6464

6565
#### Parameters

0 commit comments

Comments
 (0)