Skip to content

Commit 597997b

Browse files
committed
📖 Update 🐍Vyper Conventions
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
1 parent e4e890f commit 597997b

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

GUIDELINES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ def _as_singleton_array(element: uint256) -> DynArray[uint256, 1]:
6969

7070
- Use `internal` functions where feasible to improve composability and modularity.
7171
- Unchecked arithmetic calculations should contain comments explaining why an overflow/underflow is guaranteed not to occur.
72+
- Numeric literals should use underscores as thousand separators for readability (e.g., `1_000_000` instead of `1000000`). This applies to large constants, magic numbers, and any literal where readability would be improved.
7273
- All functions should be provided with full [NatSpec](https://docs.vyperlang.org/en/latest/natspec.html) comments containing the tags `@dev`, `@notice` (if applicable), `@param` for each function parameter, and `@return` if a return statement is present.
7374
- Please note the following order of layout:
7475
- Version pragma statement

0 commit comments

Comments
 (0)