Skip to content

gh-118150: warn in doc about results asymmetry for difflib junk#153892

Merged
encukou merged 4 commits into
python:mainfrom
Lenormju:gh-118150-difflib-autojunk-asymmetry-doc
Jul 24, 2026
Merged

gh-118150: warn in doc about results asymmetry for difflib junk#153892
encukou merged 4 commits into
python:mainfrom
Lenormju:gh-118150-difflib-autojunk-asymmetry-doc

Conversation

@Lenormju

@Lenormju Lenormju commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

@python-cla-bot

python-cla-bot Bot commented Jul 18, 2026

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

CLA signed

@bedevere-app bedevere-app Bot added the docs Documentation in the Doc dir label Jul 18, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Jul 18, 2026
@read-the-docs-community

read-the-docs-community Bot commented Jul 18, 2026

Copy link
Copy Markdown

@encukou encukou added the sprint label Jul 18, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Sprint Jul 18, 2026
@encukou encukou self-assigned this Jul 18, 2026
Comment thread Doc/library/difflib.rst Outdated
Comment thread Doc/library/difflib.rst Outdated
Comment thread Doc/library/difflib.rst Outdated
Comment thread Doc/library/difflib.rst
Comment on lines 22 to 25
.. class:: SequenceMatcher
:noindex:

This is a flexible class for comparing pairs of sequences of any type, so long

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about making this an introduction to the difflib module, rather than docs for the SequenceMatcher class (which is documented properly below)?

Something like this, plus dedenting it:

All functionality in this module uses the algorithm implemented in
:class:`SequenceMatcher`, a flexible class for comparing pairs
of sequences of any type, so long […]

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, because in the end everything relies on it. But can we do that in another PR, iteratively ?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. I'll send the PR.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sent: #154662

@encukou encukou added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels Jul 24, 2026
@encukou
encukou merged commit 59e67c2 into python:main Jul 24, 2026
36 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Jul 24, 2026
@github-project-automation github-project-automation Bot moved this from Todo to Done in Sprint Jul 24, 2026
@miss-islington-app

Copy link
Copy Markdown

Thanks @Lenormju for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15.
🐍🍒⛏🤖

@bedevere-app

bedevere-app Bot commented Jul 24, 2026

Copy link
Copy Markdown

GH-154658 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Jul 24, 2026
@bedevere-app

bedevere-app Bot commented Jul 24, 2026

Copy link
Copy Markdown

GH-154659 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jul 24, 2026
@bedevere-app

bedevere-app Bot commented Jul 24, 2026

Copy link
Copy Markdown

GH-154660 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Jul 24, 2026
encukou pushed a commit that referenced this pull request Jul 24, 2026
GH-153892) (GH-154658)

(cherry picked from commit 59e67c2)

Co-authored-by: Lenormand Julien <lenormand.julien0@gmail.com>
encukou pushed a commit that referenced this pull request Jul 24, 2026
GH-153892) (GH-154659)

(cherry picked from commit 59e67c2)

Co-authored-by: Lenormand Julien <lenormand.julien0@gmail.com>
encukou pushed a commit that referenced this pull request Jul 24, 2026
GH-153892) (GH-154660)

(cherry picked from commit 59e67c2)

Co-authored-by: Lenormand Julien <lenormand.julien0@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir sprint

Projects

Status: Done
Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants