diff --git a/doc/data/messages/i/invalid-character-carriage-return/details.rst b/doc/data/messages/i/invalid-character-carriage-return/details.rst index c1e9b976acc..2e5f239e753 100644 --- 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 `_ ! +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 index c40beb573fd..ae08661affd 100644 --- a/doc/data/messages/i/invalid-character-carriage-return/good.py +++ b/doc/data/messages/i/invalid-character-carriage-return/good.py @@ -1 +1 @@ -# This is a placeholder for correct code for this message. +STRING = "Valid carriage return: \r"