Skip to content

Commit

Permalink
bpo-43689: improve documentation for Differ (pythonGH-25132)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
jugmac00 authored May 10, 2022
1 parent 07b3492 commit fe1c5ba
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Doc/library/difflib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The ``Differ`` documentation now also mentions other whitespace characters, which make it harder to understand the diff output.

0 comments on commit fe1c5ba

Please sign in to comment.