monorail
/
Archipelago
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: style: multiline brackets (#3143)

This commit is contained in:
Doug Hoskisson 2024-04-20 17:42:27 -07:00 committed by GitHub
parent 0624ba5e81
commit a50e68acd1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/style.md
View File

@ -17,6 +17,15 @@
* Use type annotations where possible for function signatures and class members. * Use type annotations where possible for function signatures and class members.
* Use type annotations where appropriate for local variables (e.g. `var: List[int] = []`, or when the * Use type annotations where appropriate for local variables (e.g. `var: List[int] = []`, or when the
type is hard or impossible to deduce.) Clear annotations help developers look up and validate API calls. type is hard or impossible to deduce.) Clear annotations help developers look up and validate API calls.
* If a line ends with an open bracket/brace/parentheses, the matching closing bracket should be at the
beginning of a line at the same indentation as the beginning of the line with the open bracket.
```python
stuff = {
x: y
for x, y in thing
if y > 2
}
```
* New classes, attributes, and methods in core code should have docstrings that follow * New classes, attributes, and methods in core code should have docstrings that follow
[reST style](https://peps.python.org/pep-0287/). [reST style](https://peps.python.org/pep-0287/).
* Worlds that do not follow PEP8 should still have a consistent style across its files to make reading easier. * Worlds that do not follow PEP8 should still have a consistent style across its files to make reading easier.