[invalid-character-carriage-return] Create initial documentation

Refs pylint-dev#5953
Pierre-Sassoulas · Sep 17, 2023 · 4374741 · 4374741
1 parent a8af96e
commit 4374741
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/doc/data/messages/i/invalid-character-carriage-return/details.rst b/doc/data/messages/i/invalid-character-carriage-return/details.rst
@@ -1 +1,5 @@
-You can help us make the doc better `by contributing <https://github.com/pylint-dev/pylint/issues/5953>`_ !
+This message exists because one of our checker is very generic, but it's never going to
+raise during normal use as it's a ``syntax-error`` that would prevents the python ast
+(and thus pylint) to construct a code representation of the file.
+
+You could encounter it by feeding a properly constructed node directly to the checker.
diff --git a/doc/data/messages/i/invalid-character-carriage-return/good.py b/doc/data/messages/i/invalid-character-carriage-return/good.py