From 06e1773c8d8fe375423bb7fcf5922b49bc737b75 Mon Sep 17 00:00:00 2001 From: Nikita Sobolev Date: Wed, 22 Sep 2021 00:31:12 +0300 Subject: [PATCH] bpo-45216: Remove extraneous method docs from `difflib` (GH-28445) --- Lib/difflib.py | 40 ------------------- .../2021-09-18-13-45-19.bpo-45216.o56nyt.rst | 2 + 2 files changed, 2 insertions(+), 40 deletions(-) create mode 100644 Misc/NEWS.d/next/Documentation/2021-09-18-13-45-19.bpo-45216.o56nyt.rst diff --git a/Lib/difflib.py b/Lib/difflib.py index 0dda80d3875..480bad2224c 100644 --- a/Lib/difflib.py +++ b/Lib/difflib.py @@ -115,38 +115,6 @@ class SequenceMatcher: case. SequenceMatcher is quadratic time for the worst case and has expected-case behavior dependent in a complicated way on how many elements the sequences have in common; best case time is linear. - - Methods: - - __init__(isjunk=None, a='', b='') - Construct a SequenceMatcher. - - set_seqs(a, b) - Set the two sequences to be compared. - - set_seq1(a) - Set the first sequence to be compared. - - set_seq2(b) - Set the second sequence to be compared. - - find_longest_match(alo=0, ahi=None, blo=0, bhi=None) - Find longest matching block in a[alo:ahi] and b[blo:bhi]. - - get_matching_blocks() - Return list of triples describing matching subsequences. - - get_opcodes() - Return list of 5-tuples describing how to turn a into b. - - ratio() - Return a measure of the sequences' similarity (float in [0,1]). - - quick_ratio() - Return an upper bound on .ratio() relatively quickly. - - real_quick_ratio() - Return an upper bound on ratio() very quickly. """ def __init__(self, isjunk=None, a='', b='', autojunk=True): @@ -837,14 +805,6 @@ class Differ: + 4. Complicated is better than complex. ? ++++ ^ ^ + 5. Flat is better than nested. - - Methods: - - __init__(linejunk=None, charjunk=None) - Construct a text differencer, with optional filters. - - compare(a, b) - Compare two sequences of lines; generate the resulting delta. """ def __init__(self, linejunk=None, charjunk=None): diff --git a/Misc/NEWS.d/next/Documentation/2021-09-18-13-45-19.bpo-45216.o56nyt.rst b/Misc/NEWS.d/next/Documentation/2021-09-18-13-45-19.bpo-45216.o56nyt.rst new file mode 100644 index 00000000000..d10b18ecdb8 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2021-09-18-13-45-19.bpo-45216.o56nyt.rst @@ -0,0 +1,2 @@ +Remove extra documentation listing methods in ``difflib``. It was rendering +twice in pydoc and was outdated in some places.