traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

bpo-37004: Documented asymmetry of string arguments in difflib.SequenceMatcher for ratio method (GH-13482) 

https://bugs.python.org/issue37004
This commit is contained in:
sweeneyde 2019-08-07 00:37:08 -04:00 committed by Miss Islington (bot)
parent 610a4823cc
commit e9cbcd0018
2 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Doc/library/difflib.rst
View File

@ -543,6 +543,16 @@ The :class:`SequenceMatcher` class has this constructor:
to try :meth:`quick_ratio` or :meth:`real_quick_ratio` first to get an to try :meth:`quick_ratio` or :meth:`real_quick_ratio` first to get an
upper bound. upper bound.
.. note::
Caution: The result of a :meth:`ratio` call may depend on the order of
the arguments. For instance::
>>> SequenceMatcher(None, 'tide', 'diet').ratio()
0.25
>>> SequenceMatcher(None, 'diet', 'tide').ratio()
0.5
.. method:: quick_ratio() .. method:: quick_ratio()

1
Misc/NEWS.d/next/Documentation/2019-05-22-04-30-07.bpo-37004.BRgxrt.rst Normal file
View File

@ -0,0 +1 @@
In the documentation for difflib, a note was added explicitly warning that the results of SequenceMatcher's ratio method may depend on the order of the input strings.