Skip to content

Commit e4e890f

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

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

GUIDELINES.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,9 @@ def _as_singleton_array(element: uint256) -> DynArray[uint256, 1]:
7272
- 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.
7373
- Please note the following order of layout:
7474
- Version pragma statement
75-
- 🐍Vyper built-in interface imports
76-
- Custom interface imports
77-
- Module imports
75+
- 🐍Vyper built-in interface imports (one per line, with `implements` on the next line if applicable)
76+
- Custom interface imports (one per line, with `implements` on the next line if applicable)
77+
- Module imports (one per line, with `initializes` or `uses` on the next line if applicable)
7878
- Module exports
7979
- `public` constants
8080
- `internal` constants
@@ -87,7 +87,7 @@ def _as_singleton_array(element: uint256) -> DynArray[uint256, 1]:
8787
- `__default__` function
8888
- `external` functions
8989
- `internal` functions
90-
- There should be two line breaks between each variable or event declaration or function.
90+
- There should be two line breaks between each import, variable declaration, event declaration, and function.
9191
- Each line of code should be limited to a maximum of 120 characters, including spaces.
9292
- Code comments should be confined to a maximum of 80 characters per line, including spaces, with an allowed exception for comments with long URL links.
9393
- For any undocumented behavior, please refer to [🐍Vyper's Official Style Guide](https://docs.vyperlang.org/en/latest/style-guide.html) and/or [PEP 8 – Style Guide for Python Code](https://peps.python.org/pep-0008).

0 commit comments

Comments
 (0)