[m-rev.] for review: add "did you mean" reminders for mistyped predicate names

[Zoltan Somogyi]

On 2023-09-25 04:27 +10:00 AEST, "Zoltan Somogyi" <zoltan.somogyi at runbox.com> wrote:
> I would add a note to edit_seq.m about the existence of
> edit_distance.m. (The form of the note would depend on
> the chosen option, which is why I haven't written it yet.)
> The fate of the new test cases for edit_seq.m also depends on this
> decision.

This is that diff. For review by anyone.

Zoltan.

diff --git a/library/edit_seq.m b/library/edit_seq.m
index fb2b1ea40..ffd8aa6b2 100644
--- a/library/edit_seq.m
+++ b/library/edit_seq.m
@@ -19,6 +19,16 @@
 % Given two lists of length M and N, its time complexity is O(MN),
 % so it is suitable for use only on reasonably short lists.
 %
+% The operations in this module are intended to generate diffs to be displayed.
+% Since diff traditionally have no way to display a transposition as
+% anything other than an insertion/deletion pair, this module does not
+% consider transpositions to be a separate kind of operation, which means
+% that the distances it computes are Levenshtein distances.
+% If you are after Damerau-Levenshtein distances, which *do* consider
+% transpositions to be separate operations with their own costs,
+% or if you want to know which of several candidate sequences is closest
+% to a specific query sequence, then have a look at the edit_distance module.
+%
 %---------------------------------------------------------------------------%
 %---------------------------------------------------------------------------%