fixup readme

Author: MarcoGorelli

README.md

@@ -18,21 +18,21 @@ a linter for pandas usage, please see [pandas-vet](https://github.com/deppen8/pa
 
 | Code   | Description                                                             |
 |--------|-------------------------------------------------------------------------|
-| PDF001 | found import from collections.abc (use 'from collections import abc')   |
-| PDF002 | builtin filter function used                                            |
-| PDF003 | builtin exec used                                                       |
+| PDF001 | found import from 'collections.abc' (use 'from collections import abc') |
+| PDF002 | builtin 'filter' function used                                            |
+| PDF003 | builtin 'exec' function used                                                       |
 | PDF004 | 'foo.\_\_class\_\_' used, (use 'type(foo)' instead)                     |
 | PDF005 | leading space in concatenated strings                                   |
 | PDF006 | Found '{foo!r}' formatted value (instead, use 'repr(foo)')              |
 | PDF007 | line split in two unnecessarily by 'black' formatter                    |
 | PDF008 | found 'os.remove' (use 'tm.ensure_clean' instead)                       |
 | PDF009 | 'pytest.raises' used without 'match='                                   |
 | PDF010 | 'pytest.raises' used outside of context manager                         |
-| PDF011 | found pytest.warns (use pandas._testing.assert_produces_warning)        |
-| PDF012 | found pytest.xfail (use pytest.mark.xfail instead)                      |
+| PDF011 | found 'pytest.warns' (use 'pandas._testing.assert_produces_warning')    |
+| PDF012 | found 'pytest.xfail' (use 'pytest.mark.xfail' instead)                  |
 | PDF013 | import from 'conftest' found                                            |
 | PDF014 | found import from 'pandas._testing' (use 'import pandas._testing as tm')|
-| PDF015 | don't import from pandas.testing                                        |
+| PDF015 | from import from 'pandas.testing' (use 'import pandas._testing as tm')  |
 | PDF016 | found 'unittest.mock' (use 'pytest.monkeypatch' instead)                |
 | PDF017 | 'pd.api.types' used (import from 'pandas.api.types' instead)            |
 | PDF018 | 'common' imported from 'pandas.core' without 'comm' alias               |

pandas_dev_flaker/_plugins_tree/builtin_filter.py

@@ -3,7 +3,7 @@
 
 from pandas_dev_flaker._data_tree import State, register
 
-MSG = "PDF002 builtin filter function used"
+MSG = "PDF002 builtin 'filter' function used"
 
 
 @register(ast.Call)

pandas_dev_flaker/_plugins_tree/collections_abc.py

@@ -4,7 +4,7 @@
 from pandas_dev_flaker._data_tree import State, register
 
 MSG = (
-    "PDF001 found import from collections.abc "
+    "PDF001 found import from 'collections.abc' "
     "(use 'from collections import abc')"
 )
 

pandas_dev_flaker/_plugins_tree/exec_usage.py

@@ -3,7 +3,7 @@
 
 from pandas_dev_flaker._data_tree import State, register
 
-MSG = "PDF003 builtin exec used"
+MSG = "PDF003 builtin 'exec' function used"
 
 
 @register(ast.Call)

pandas_dev_flaker/_plugins_tree/pytest_warns.py

@@ -4,8 +4,8 @@
 from pandas_dev_flaker._data_tree import State, register
 
 MSG = (
-    "PDF011 found pytest.warns "
-    "(use pandas._testing.assert_produces_warning)"
+    "PDF011 found 'pytest.warns' "
+    "(use 'pandas._testing.assert_produces_warning')"
 )
 
 

pandas_dev_flaker/_plugins_tree/pytest_xfail.py

@@ -3,7 +3,7 @@
 
 from pandas_dev_flaker._data_tree import State, register
 
-MSG = "PDF012 found pytest.xfail (use pytest.mark.xfail instead)"
+MSG = "PDF012 found 'pytest.xfail' (use 'pytest.mark.xfail' instead)"
 
 
 @register(ast.FunctionDef)

tests/builtin_exec_test.py

@@ -35,7 +35,7 @@ def test_noop(source):
     (
         pytest.param(
             "exec('str')",
-            "1:0: PDF003 builtin exec used",
+            "1:0: PDF003 builtin 'exec' function used",
             id="builtin exec",
         ),
     ),

tests/builtin_filter_test.py

@@ -35,7 +35,7 @@ def test_noop(source):
     (
         pytest.param(
             "lst = [1,2,3]\n" "filter(lambda x: x, lst)",
-            "2:0: PDF002 builtin filter function used",
+            "2:0: PDF002 builtin 'filter' function used",
             id="builtin filter",
         ),
     ),

tests/collections_abc_test.py

@@ -35,25 +35,25 @@ def test_noop(source):
     (
         pytest.param(
             "from collections.abc.Generator import foo",
-            "1:0: PDF001 found import from collections.abc "
+            "1:0: PDF001 found import from 'collections.abc' "
             "(use 'from collections import abc')",
             id="3rd level 'from' import",
         ),
         pytest.param(
             "from collections.abc import Generator",
-            "1:0: PDF001 found import from collections.abc "
+            "1:0: PDF001 found import from 'collections.abc' "
             "(use 'from collections import abc')",
             id="2nd level 'from' import",
         ),
         pytest.param(
             "import collections.abc.Generator",
-            "1:0: PDF001 found import from collections.abc "
+            "1:0: PDF001 found import from 'collections.abc' "
             "(use 'from collections import abc')",
             id="3rd level import",
         ),
         pytest.param(
             "import collections.abc",
-            "1:0: PDF001 found import from collections.abc "
+            "1:0: PDF001 found import from 'collections.abc' "
             "(use 'from collections import abc')",
             id="2nd level import",
         ),

tests/pandas_testing_test.py

@@ -43,7 +43,7 @@ def test_noop(source):
             "from pandas.testing import foo",
             "1:0: PDF015 found import from 'pandas.testing' "
             "(use 'import pandas._testing as tm')",
-            id="import from pandas.testing",
+            id="import from 'pandas.testing'",
         ),
         pytest.param(
             "import pandas\n" "pandas.testing.foo",

tests/pytest_warns_test.py

@@ -35,14 +35,14 @@ def test_noop(source):
     (
         pytest.param(
             "from pytest import warns\n",
-            "1:0: PDF011 found pytest.warns "
-            "(use pandas._testing.assert_produces_warning)",
+            "1:0: PDF011 found 'pytest.warns' "
+            "(use 'pandas._testing.assert_produces_warning')",
             id="warns used, imported from pytest",
         ),
         pytest.param(
             "import pytest\n" "with pytest.warns(): pass",
-            "2:5: PDF011 found pytest.warns "
-            "(use pandas._testing.assert_produces_warning)",
+            "2:5: PDF011 found 'pytest.warns' "
+            "(use 'pandas._testing.assert_produces_warning')",
             id="pytest.warns used",
         ),
     ),

tests/pytest_xfail_test.py

@@ -35,12 +35,14 @@ def test_noop(source):
     (
         pytest.param(
             "from pytest import xfail\n",
-            "1:0: PDF012 found pytest.xfail (use pytest.mark.xfail instead)",
+            "1:0: PDF012 found 'pytest.xfail' "
+            "(use 'pytest.mark.xfail' instead)",
             id="xfail used, imported from pytest",
         ),
         pytest.param(
             "import pytest\n" "@pytest.xfail\n" "def testme(): ...",
-            "3:0: PDF012 found pytest.xfail (use pytest.mark.xfail instead)",
+            "3:0: PDF012 found 'pytest.xfail' "
+            "(use 'pytest.mark.xfail' instead)",
             id="pytest.xfail used",
         ),
     ),