bpo-43689: improve documentation for Differ (pythonGH-25132)

jugmac00 · web-flow · commit fe1c5ba60878 · 2022-05-10T13:57:12.000-07:00
Lines beginning with ``?`` try to help understanding the given diff.

The output can be hard to understand when it contains whitespace characters, such as spaces, tabs or line breaks.

While previously only tabs were mentioned, now all are listed.

Automerge-Triggered-By: GH:rhettinger
diff --git a/Doc/library/difflib.rst b/Doc/library/difflib.rst
@@ -79,7 +79,7 @@ diffs. For comparing directories and files, see also, the :mod:`filecmp` module.
 
    Lines beginning with '``?``' attempt to guide the eye to intraline differences,
    and were not present in either input sequence. These lines can be confusing if
-   the sequences contain tab characters.
+   the sequences contain whitespace characters, such as spaces, tabs or line breaks.
 
 
 .. class:: HtmlDiff
diff --git a/Misc/NEWS.d/next/Documentation/2021-04-01-08-09-34.bpo-43689.mqCfLe.rst b/Misc/NEWS.d/next/Documentation/2021-04-01-08-09-34.bpo-43689.mqCfLe.rst
@@ -0,0 +1 @@
+The ``Differ`` documentation now also mentions other whitespace characters, which make it harder to understand the diff output.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+The ``Differ`` documentation now also mentions other whitespace characters, which make it harder to understand the diff output.