[doc] Add an example for 'non-ascii-file-name'

And move links to related.rst
pylint-dev · Feb 25, 2023 · 7d3c34c · 7d3c34c
1 parent 8bf1120
commit 7d3c34c
Show file tree

Hide file tree

Showing 9 changed files with 12 additions and 16 deletions.
diff --git a/doc/data/messages/n/non-ascii-file-name/bad/bàd.py b/doc/data/messages/n/non-ascii-file-name/bad/bàd.py
@@ -0,0 +1 @@
+# [non-ascii-file-name]
diff --git a/doc/data/messages/n/non-ascii-file-name/bad/not_bétter.py b/doc/data/messages/n/non-ascii-file-name/bad/not_bétter.py
@@ -0,0 +1 @@
+# [non-ascii-file-name]
diff --git a/doc/data/messages/n/non-ascii-file-name/details.rst b/doc/data/messages/n/non-ascii-file-name/details.rst
diff --git a/doc/data/messages/n/non-ascii-file-name/good.py b/doc/data/messages/n/non-ascii-file-name/good.py
diff --git a/doc/data/messages/n/non-ascii-file-name/good/bad.py b/doc/data/messages/n/non-ascii-file-name/good/bad.py
diff --git a/doc/data/messages/n/non-ascii-file-name/good/not_better.py b/doc/data/messages/n/non-ascii-file-name/good/not_better.py
diff --git a/doc/data/messages/n/non-ascii-file-name/related.rst b/doc/data/messages/n/non-ascii-file-name/related.rst
@@ -0,0 +1,3 @@
+- `PEP 489 <https://peps.python.org/pep-0489/#export-hook-name>`_
+- `PEP 672 <https://peps.python.org/pep-0672/#confusing-features>`_
+- `Python issue 20485 <https://bugs.python.org/issue20485>`_
diff --git a/pylint/checkers/non_ascii_names.py b/pylint/checkers/non_ascii_names.py
@@ -43,22 +43,15 @@ class NonAsciiNameChecker(base_checker.BaseChecker):
         ),
         # First %s will always be "file"
         "W2402": (
-            (
-                '%s name "%s" contains a non-ASCII character. PEP 3131 only allows '
-                "non-ascii identifiers, not file names."
-            ),
+            '%s name "%s" contains a non-ASCII character.',
             "non-ascii-file-name",
             (
                 # Some = PyCharm at the time of writing didn't display the non_ascii_name_loł
-                # files and had big troubles with git.
-                # Probably only a bug shows the problem quite good.
-                # That's also why this is a warning and not only a convention!
-                "Some editors don't support non-ASCII file names properly. "
-                "Even though Python supports UTF-8 files since Python 3.5 this isn't "
-                "recommended for interoperability. Further reading:\n"
-                "- https://peps.python.org/pep-0489/#export-hook-name\n"
-                "- https://peps.python.org/pep-0672/#confusing-features\n"
-                "- https://bugs.python.org/issue20485"
+                # files and had big troubles with git. Probably only a bug shows the problem
+                # quite good. That's also why this is a warning and not only a convention!
+                "Under python 3.5, PEP 3131 only allows non-ascii identifiers, not file names."
+                "Since Python 3.5, even though Python supports UTF-8 files, some editors or tools "
+                "don't. "
             ),
         ),
         # First %s will always be "module"

diff --git a/tests/functional/n/non_ascii_name/non_ascii_name_loł.txt b/tests/functional/n/non_ascii_name/non_ascii_name_loł.txt
@@ -1 +1 @@
-non-ascii-file-name:1:0:None:None::"File name ""non_ascii_name_loł"" contains a non-ASCII character. PEP 3131 only allows non-ascii identifiers, not file names.":HIGH
+non-ascii-file-name:1:0:None:None::"File name ""non_ascii_name_loł"" contains a non-ASCII character.":HIGH
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		non-ascii-file-name:1:0:None:None::"File name ""non_ascii_name_loł"" contains a non-ASCII character. PEP 3131 only allows non-ascii identifiers, not file names.":HIGH
		non-ascii-file-name:1:0:None:None::"File name ""non_ascii_name_loł"" contains a non-ASCII character.":HIGH