Skip to content

Commit b91adc9

Browse files
committed
📖 Formatting
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
1 parent be82bb5 commit b91adc9

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

GUIDELINES.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -93,14 +93,14 @@ def forward_call(target: address) -> Bytes[1_024]:
9393
- Optimisation mode (if applicable): `# pragma optimize <mode>`
9494
- Nonreentrancy (if applicable): `# pragma nonreentrancy <flag>`
9595
- Experimental code generation (=[Venom](https://github.com/vyperlang/vyper/tree/master/vyper/venom)) (if applicable): `# pragma experimental-codegen`
96-
- 🐍Vyper built-in interface imports (one per line, with `implements` on the next line if applicable)
97-
- Custom interface imports (one per line, with `implements` on the next line if applicable)
98-
- Module imports (one per line, with `initializes` or `uses` on the next line if applicable)
99-
- Module exports
100-
- `public` constants
101-
- `internal` constants
102-
- `public` immutables
103-
- `internal` immutables
96+
- 🐍Vyper built-in interface `import`s (one per line, with `implements` on the next line if applicable)
97+
- Custom interface `import`s (one per line, with `implements` on the next line if applicable)
98+
- Module `import`s (one per line, with `initializes` or `uses` on the next line if applicable)
99+
- Module `exports`
100+
- `public` `constant`s
101+
- `internal` `constant`s
102+
- `public` `immutable`s
103+
- `internal` `immutable`s
104104
- `flag` definitions
105105
- `struct` definitions
106106
- `public` state variables
@@ -110,7 +110,7 @@ def forward_call(target: address) -> Bytes[1_024]:
110110
- `__default__` function
111111
- `external` functions
112112
- `internal` functions
113-
- There should be two line breaks between each import, variable declaration, event declaration, and function.
113+
- There should be two line breaks between each top-level declaration, including `import`s, `constant`s, `immutable`s, `flag`s, `struct`s, state variables, `event`s, and functions.
114114
- Each line of code should be limited to a maximum of 120 characters, including spaces.
115115
- 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.
116-
- 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).
116+
- For any undocumented behaviour, 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)