gh-56593: Document the difflib Match named tuple - #155598
Open
Khan3K wants to merge 2 commits into
Open
Conversation
The docs and docstrings described the results of SequenceMatcher's find_longest_match() and get_matching_blocks() as plain (i, j, k) triples even though they are Match named tuples, and Match itself was not documented. Add a description of Match to the docs, state the return type explicitly in both methods, and clarify that the diff functions accept sequences of strings rather than lists.
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
|
The following commit authors need to sign the Contributor License Agreement: |
Documentation build overview
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs and docstrings described the results of
SequenceMatcher.find_longest_match()andSequenceMatcher.get_matching_blocks()as plain(i, j, k)triples even though they areMatchnamed tuples, andMatchitself was not documented at all.Changes:
Matchnamed tuple description toDoc/library/difflib.rst(fieldsa,b,size), mirroring how other named tuple types likestruct_timeare documented.Matchreturn type explicitly at the top offind_longest_match()andget_matching_blocks()in both the docs and the docstrings, and describe the no-match case asMatch(alo, blo, 0).make_file,make_table,context_diff,ndiff, andunified_diff, matching the actual behavior and the existing docstrings.Linked PRs