diff options
| author | sweeneyde <36520290+sweeneyde@users.noreply.github.com> | 2019-08-07 04:37:08 (GMT) |
|---|---|---|
| committer | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2019-08-07 04:37:08 (GMT) |
| commit | e9cbcd0018abd2a5f2348c45d5c9c4265c4f42dc (patch) | |
| tree | 0eebe37ba186d8615ee291b49a304bbd58cafa12 | |
| parent | 610a4823cc0a3c2380ad0dfe64ae483ced4e5304 (diff) | |
| download | cpython-e9cbcd0018abd2a5f2348c45d5c9c4265c4f42dc.zip cpython-e9cbcd0018abd2a5f2348c45d5c9c4265c4f42dc.tar.gz cpython-e9cbcd0018abd2a5f2348c45d5c9c4265c4f42dc.tar.bz2 | |
bpo-37004: Documented asymmetry of string arguments in difflib.SequenceMatcher for ratio method (GH-13482)
https://bugs.python.org/issue37004
| -rw-r--r-- | Doc/library/difflib.rst | 10 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/Documentation/2019-05-22-04-30-07.bpo-37004.BRgxrt.rst | 1 |
2 files changed, 11 insertions, 0 deletions
diff --git a/Doc/library/difflib.rst b/Doc/library/difflib.rst index f044cb2..e245ab8 100644 --- a/Doc/library/difflib.rst +++ b/Doc/library/difflib.rst @@ -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 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() diff --git a/Misc/NEWS.d/next/Documentation/2019-05-22-04-30-07.bpo-37004.BRgxrt.rst b/Misc/NEWS.d/next/Documentation/2019-05-22-04-30-07.bpo-37004.BRgxrt.rst new file mode 100644 index 0000000..dfc8b7e --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2019-05-22-04-30-07.bpo-37004.BRgxrt.rst @@ -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.
\ No newline at end of file |