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 c1e9b976ac..283e7b5e8a 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 checkers is very generic, but it's never going to +raise during normal use as it's a ``syntax-error`` that would prevent the python ast +(and thus pylint) from constructing 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 c40beb573f..ae08661aff 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" diff --git a/doc/data/messages/i/invalid-character-nul/details.rst b/doc/data/messages/i/invalid-character-nul/details.rst index c1e9b976ac..c131132bf5 100644 --- a/doc/data/messages/i/invalid-character-nul/details.rst +++ b/doc/data/messages/i/invalid-character-nul/details.rst @@ -1 +1,2 @@ -You can help us make the doc better `by contributing `_ ! +There's no need to use end-of-string characters. String objects maintain their +own length. diff --git a/doc/data/messages/i/invalid-character-nul/good.py b/doc/data/messages/i/invalid-character-nul/good.py index c40beb573f..97e1a3bcf3 100644 --- a/doc/data/messages/i/invalid-character-nul/good.py +++ b/doc/data/messages/i/invalid-character-nul/good.py @@ -1 +1 @@ -# This is a placeholder for correct code for this message. +STRING = "Valid nul terminator: \x00" diff --git a/doc/data/messages/i/invalid-character-nul/related.rst b/doc/data/messages/i/invalid-character-nul/related.rst new file mode 100644 index 0000000000..2f08c333e7 --- /dev/null +++ b/doc/data/messages/i/invalid-character-nul/related.rst @@ -0,0 +1 @@ +- `Null terminator in python `_