summary refs log tree commit diff stats
path: root/plugins/python/python_style_guide.md
blob: 41db2474c029983805d25056180557fcc2fe0238 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# HexChat Python Module Style Guide

(This is a work in progress).

## General rules

- PEP8 as general fallback recommendations
- Max line length: 120
- Avoid overcomplex compound statements. i.e. dont do this: `somevar = x if x == y else z if a == b and c == b else x`

## Indentation style

### Multi-line functions

```python
foo(really_long_arg_1,
    really_long_arg_2)
```

### Mutli-line lists/dicts

```python
foo = {
    'bar': 'baz',
}
```