[mixed-line-endings] Create the initial documentation (#8994)

Refs #5953
pylint-dev · Sep 3, 2023 · de56b55 · de56b55
1 parent 2d3aadd
commit de56b55
Show file tree

Hide file tree

Showing 9 changed files with 14 additions and 6 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -4,3 +4,4 @@ tests/input/** -text
 tests/**/data/** -text
 tests/regrtest_data/** -text
 doc/data/messages/u/unexpected-line-ending-format/bad.py -text
+doc/data/messages/m/mixed-line-endings/bad.py -text
diff --git a/doc/data/messages/m/mixed-line-endings/bad.py b/doc/data/messages/m/mixed-line-endings/bad.py
@@ -0,0 +1,2 @@
+print("Hello")  # CRLF (\r\n)
+print("World")  # LF (\n) # [mixed-line-endings]
diff --git a/doc/data/messages/m/mixed-line-endings/details.rst b/doc/data/messages/m/mixed-line-endings/details.rst
diff --git a/doc/data/messages/m/mixed-line-endings/good.py b/doc/data/messages/m/mixed-line-endings/good.py
diff --git a/doc/data/messages/m/mixed-line-endings/good/full_crlf.py b/doc/data/messages/m/mixed-line-endings/good/full_crlf.py
@@ -0,0 +1,2 @@
+print("Hello")  # CRLF (\r\n)
+print("World")  # CRLF (\r\n)
diff --git a/doc/data/messages/m/mixed-line-endings/good/full_lf.py b/doc/data/messages/m/mixed-line-endings/good/full_lf.py
@@ -0,0 +1,2 @@
+print("Hello")  # LF (\n)
+print("World")  # LF (\n)
diff --git a/doc/data/messages/m/mixed-line-endings/related.rst b/doc/data/messages/m/mixed-line-endings/related.rst
@@ -0,0 +1,3 @@
+- `History of CRLF and LF <https://stackoverflow.com/a/6521730/2519059>`_
+- `Dealing with line endings in Git <https://stackoverflow.com/a/10855862/2519059>`_
+- `A Collection of Useful .gitattributes Templates <https://github.com/alexkaratarakis/gitattributes>`_
diff --git a/doc/data/messages/u/unexpected-line-ending-format/bad.py b/doc/data/messages/u/unexpected-line-ending-format/bad.py
@@ -1,2 +1,2 @@
-print("Sometimes I drink soda.")  # CRLF # [unexpected-line-ending-format]
-print("Sometimes I drink sulfuric acid.")  # CRLF # [unexpected-line-ending-format]
+print("I'm drinking tea!")  # CRLF (\r\n) # [unexpected-line-ending-format]
+print("I'm drinking water!")  # CRLF (\r\n) # [unexpected-line-ending-format]
diff --git a/doc/data/messages/u/unexpected-line-ending-format/good.py b/doc/data/messages/u/unexpected-line-ending-format/good.py
@@ -1,2 +1,2 @@
-print("I'm drinking tea!")  # LF
-print("I'm drinking water!")  # LF
+print("I'm drinking tea!")  # LF (\n)
+print("I'm drinking water!")  # LF (\n)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		print("Hello") # CRLF (\r\n)
		print("World") # LF (\n) # [mixed-line-endings]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		print("Hello") # CRLF (\r\n)
		print("World") # CRLF (\r\n)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		print("Hello") # LF (\n)
		print("World") # LF (\n)