diff options
| author | Robert Hofer <1058012+hofrob@users.noreply.github.com> | 2023-02-06 18:01:55 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-06 18:01:55 +0100 |
| commit | c31a3e1e36fdc24a9e85b1f5a2fa95ec85073764 (patch) | |
| tree | c3de589d61ec2b5f2461772c6076bb55949cbad0 /doc/data/messages/m/missing-final-newline | |
| parent | f0c5f91a7818b7ba5970e6f64562973ee946d1b1 (diff) | |
| download | pylint-git-c31a3e1e36fdc24a9e85b1f5a2fa95ec85073764.tar.gz | |
Add doc for message missing-final-newline (#8195)
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
Diffstat (limited to 'doc/data/messages/m/missing-final-newline')
4 files changed, 23 insertions, 2 deletions
diff --git a/doc/data/messages/m/missing-final-newline/bad.py b/doc/data/messages/m/missing-final-newline/bad.py new file mode 100644 index 000000000..06c6734ce --- /dev/null +++ b/doc/data/messages/m/missing-final-newline/bad.py @@ -0,0 +1,10 @@ +# using LF + +eat("apple", "candy") # \n +print(123) # EOF + +# using CRLF + +eat("apple", "candy") # \r\n +print(123) # EOF +# [missing-final-newline]
\ No newline at end of file diff --git a/doc/data/messages/m/missing-final-newline/details.rst b/doc/data/messages/m/missing-final-newline/details.rst index ab8204529..ddbc937d0 100644 --- a/doc/data/messages/m/missing-final-newline/details.rst +++ b/doc/data/messages/m/missing-final-newline/details.rst @@ -1 +1,2 @@ -You can help us make the doc better `by contributing <https://github.com/PyCQA/pylint/issues/5953>`_ ! +The POSIX standard defines a line as: + "A sequence of zero or more non- <newline> characters plus a terminating <newline> character." diff --git a/doc/data/messages/m/missing-final-newline/good.py b/doc/data/messages/m/missing-final-newline/good.py index c40beb573..fa1e5072e 100644 --- a/doc/data/messages/m/missing-final-newline/good.py +++ b/doc/data/messages/m/missing-final-newline/good.py @@ -1 +1,9 @@ -# This is a placeholder for correct code for this message. +# using LF + +eat("apple", "candy") # \n +print(123) # \nEOF + +# using CRLF + +eat("apple", "candy") # \r\n +print(123) # \r\nEOF diff --git a/doc/data/messages/m/missing-final-newline/related.rst b/doc/data/messages/m/missing-final-newline/related.rst new file mode 100644 index 000000000..4e589e1df --- /dev/null +++ b/doc/data/messages/m/missing-final-newline/related.rst @@ -0,0 +1,2 @@ +- `POSIX Standard <https://pubs.opengroup.org/onlinepubs/9699919799/>`_ +- `POSIX Standard Chapter 3.206 Line <https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206>`_ |