summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTerry Jan Reedy <tjreedy@udel.edu>2018-10-27 03:03:08 (GMT)
committerGitHub <noreply@github.com>2018-10-27 03:03:08 (GMT)
commitd9bff4e81b8ca36fe6c4e90c0b9cf02bc020e713 (patch)
treece0d9858464a68ecd4241b47b972c20f6362631c
parent12e696b4f071ffe0d585b7f0d0d8020fd328bfdd (diff)
downloadcpython-d9bff4e81b8ca36fe6c4e90c0b9cf02bc020e713.zip
cpython-d9bff4e81b8ca36fe6c4e90c0b9cf02bc020e713.tar.gz
cpython-d9bff4e81b8ca36fe6c4e90c0b9cf02bc020e713.tar.bz2
bpo-35079: Revise difflib.SequenceManager.get_matching_blocks doc (GH-10144)
Specify that blocks are non-overlapping. Change '!=' to '<'.
-rw-r--r--Doc/library/difflib.rst7
-rw-r--r--Misc/NEWS.d/next/Library/2018-10-26-22-53-16.bpo-35079.Tm5jvF.rst2
2 files changed, 6 insertions, 3 deletions
diff --git a/Doc/library/difflib.rst b/Doc/library/difflib.rst
index 6743bdc..f044cb2 100644
--- a/Doc/library/difflib.rst
+++ b/Doc/library/difflib.rst
@@ -457,14 +457,15 @@ The :class:`SequenceMatcher` class has this constructor:
.. method:: get_matching_blocks()
- Return list of triples describing matching subsequences. Each triple is of
- the form ``(i, j, n)``, and means that ``a[i:i+n] == b[j:j+n]``. The
+ Return list of triples describing non-overlapping matching subsequences.
+ Each triple is of the form ``(i, j, n)``,
+ and means that ``a[i:i+n] == b[j:j+n]``. The
triples are monotonically increasing in *i* and *j*.
The last triple is a dummy, and has the value ``(len(a), len(b), 0)``. It
is the only triple with ``n == 0``. If ``(i, j, n)`` and ``(i', j', n')``
are adjacent triples in the list, and the second is not the last triple in
- the list, then ``i+n != i'`` or ``j+n != j'``; in other words, adjacent
+ the list, then ``i+n < i'`` or ``j+n < j'``; in other words, adjacent
triples always describe non-adjacent equal blocks.
.. XXX Explain why a dummy is used!
diff --git a/Misc/NEWS.d/next/Library/2018-10-26-22-53-16.bpo-35079.Tm5jvF.rst b/Misc/NEWS.d/next/Library/2018-10-26-22-53-16.bpo-35079.Tm5jvF.rst
new file mode 100644
index 0000000..33f6dc4
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2018-10-26-22-53-16.bpo-35079.Tm5jvF.rst
@@ -0,0 +1,2 @@
+Improve difflib.SequenceManager.get_matching_blocks doc by adding 'non-
+overlapping' and changing '!=' to '<'.