From: Jürgen Gmach Date: Tue, 10 May 2022 20:57:12 +0000 (+0200) Subject: bpo-43689: improve documentation for Differ (GH-25132) X-Git-Tag: v3.12.0a1~1595 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=fe1c5ba60878482b34b60de36424390a2dcdae50;p=thirdparty%2FPython%2Fcpython.git bpo-43689: improve documentation for Differ (GH-25132) 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 index aa08988c8b36..10f8808d33b1 100644 --- 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 new file mode 100644 index 000000000000..5cc13d7068c9 --- /dev/null +++ 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.