From 6b78c4825588d3158b9a21e19365b4ea0269cc31 Mon Sep 17 00:00:00 2001 From: Tal Einat Date: Mon, 26 Jun 2017 23:06:03 +0300 Subject: [PATCH] Update README.rst --- README.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 792d237..2223985 100644 --- a/README.rst +++ b/README.rst @@ -82,15 +82,16 @@ you're looking for, and the matching parameters: >>> find_near_matches(subsequence, sequence, max_l_dist=2) [Match(start=3, end=24, dist=1)] -Advanced Example ----------------- +Advanced Search Criteria +------------------------ The search function supports four possible match criteria, which may be supplied in any combination: + * maximum Levenshtein distance * maximum # of subsitutions * maximum # of deletions (elements appearing in the pattern search for, which are skipped in the matching sub-sequence) * maximum # of insertions (elements added in the matching sub-sequence which don't appear in the pattern search for) -Not supplying a criterion means that there is no limit for it. For this reason, one must always supply `max_l_dist` and/or all of the other three criteria. +Not supplying a criterion means that there is no limit for it. For this reason, one must always supply `max_l_dist` and/or all other criteria. .. code:: python