Skip to content

Commit 30f2c75

Browse files
committed
Add some clarifications to README
1 parent 41a9bc8 commit 30f2c75

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ $ flake8 --version
2727
```
2828

2929
## Table of Warnings
30+
All warnings are enabled by default.
31+
3032
### Function Annotations
3133
| ID | Description |
3234
|----------|-----------------------------------------------|
@@ -35,10 +37,10 @@ $ flake8 --version
3537
| `ANN003` | Missing type annotation for `**kwargs` |
3638

3739
### Method Annotations
38-
| ID | Description |
39-
|----------|----------------------------------------------------|
40-
| `ANN101` | Missing type annotation for `self` in method |
41-
| `ANN102` | Missing type annotation for `cls` in classmethod |
40+
| ID | Description |
41+
|----------|--------------------------------------------------------------|
42+
| `ANN101` | Missing type annotation for `self` in method<sup>1</sup> |
43+
| `ANN102` | Missing type annotation for `cls` in classmethod<sup>1</sup> |
4244

4345
### Return Annotations
4446
| ID | Description |
@@ -55,6 +57,9 @@ $ flake8 --version
5557
|----------|-----------------------------------------------------------|
5658
| `ANN301` | PEP 484 disallows both type annotations and type comments |
5759

60+
**Notes:**
61+
1. See: [PEP 484](https://www.python.org/dev/peps/pep-0484/#annotating-instance-and-class-methods) and [PEP 563](https://www.python.org/dev/peps/pep-0563/) for suggestions on annotating `self` and `cls` arguments.
62+
5863

5964
## Configuration Options
6065
Some opinionated flags are provided to tailor the linting errors emitted:

0 commit comments

Comments
 (0)