GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-56593: Document the difflib Match named tuple by Khan3K · Pull Request #155598 · python/cpython

Conversation

@Khan3K

@Khan3K Khan3K commented Aug 12, 2026

Copy link
Copy Markdown
  • Issue: difflib.SequenceMatcher and Match: code and doc bugs #56593

The docs and docstrings described the results of SequenceMatcher.find_longest_match() and SequenceMatcher.get_matching_blocks() as plain (i, j, k) triples even though they are Match named tuples, and Match itself was not documented at all.

Changes:

  • Add a Match named tuple description to Doc/library/difflib.rst (fields a, b, size), mirroring how other named tuple types like struct_time are documented.
  • State the Match return type explicitly at the top of find_longest_match() and get_matching_blocks() in both the docs and the docstrings, and describe the no-match case as Match(alo, blo, 0).
  • Replace "lists of strings" with "sequences of strings" in the docs for make_file, make_table, context_diff, ndiff, and unified_diff, matching the actual behavior and the existing docstrings.

Linked PRs

  • difflib.SequenceMatcher and Match: code and doc bugs #56593

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@bedevere-app

bedevere-app Bot commented Aug 12, 2026

Copy link
Copy Markdown

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 skip news label instead.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@python-cla-bot

python-cla-bot Bot commented Aug 12, 2026 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

CLA signed

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-app bedevere-app Bot mentioned this pull request Aug 12, 2026
difflib.SequenceMatcher and Match: code and doc bugs #56593
Open
@bedevere-app bedevere-app Bot added the awaiting review label Aug 12, 2026
@read-the-docs-community

read-the-docs-community Bot commented Aug 12, 2026 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #34030935 | 📁 Comparing a34e08c against main (ee68f5f)

  🔍 Preview build  

2 files changed
± library/difflib.html
± whatsnew/changelog.html
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@StanFromIreland

StanFromIreland commented Aug 12, 2026

Copy link
Copy Markdown
Member

You must sign the CLA before we can review.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@StanFromIreland
StanFromIreland marked this pull request as draft August 12, 2026 09:11
@bedevere-app bedevere-app Bot removed the awaiting review label Aug 12, 2026
Khan3K added 2 commits August 12, 2026 19:23
@Khan3K
pythongh-56593: Document the difflib Match named tuple
b9204a4
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.
@Khan3K
Add news entry for pythongh-56593 docs improvement
a34e08c
@Khan3K
Khan3K force-pushed the difflib-docs-match branch from 5c6dc38 to a34e08c Compare August 12, 2026 11:23
@github-actions

github-actions Bot commented Nov 12, 2026

Copy link
Copy Markdown

This PR is stale because it has been open for 90 days with no activity.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label Nov 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

stale Stale PR or inactive for long period of time.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@Khan3K @StanFromIreland
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.