Add rules to Readme, fix capitalization

gforcada · Sep 28, 2023 · dfbdca6 · dfbdca6
1 parent 2ff0b74
commit dfbdca6
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -86,6 +86,21 @@ Requirements
 - Python 3.8, 3.9, 3.10, 3.11, and pypy3
 - flake8
 
+Rules
+-----
+
+A001:
+  A variable is shadowing a Python builtin.
+
+A002:
+  An argument is shadowing a Python builtin.
+
+A003:
+  A class attribute is shadowing a Python builtin.
+
+A004:
+  An import statement is shadowing a Python builtin.
+
 License
 -------
 GPL 2.0
diff --git a/flake8_builtins.py b/flake8_builtins.py
@@ -14,9 +14,9 @@
 class BuiltinsChecker:
     name = 'flake8_builtins'
     version = '1.5.2'
-    assign_msg = 'A001 variable "{0}" is shadowing a python builtin'
-    argument_msg = 'A002 argument "{0}" is shadowing a python builtin'
-    class_attribute_msg = 'A003 class attribute "{0}" is shadowing a python builtin'
+    assign_msg = 'A001 variable "{0}" is shadowing a Python builtin'
+    argument_msg = 'A002 argument "{0}" is shadowing a Python builtin'
+    class_attribute_msg = 'A003 class attribute "{0}" is shadowing a Python builtin'
     import_msg = 'A004 import statement "{0}" is shadowing a Python builtin'
 
     names = []