Skip to content

gh-153899: Fix documented parameter names for filecmp.cmpfiles#153900

Merged
picnixz merged 2 commits into
python:mainfrom
fedonman:fix-gh-153899-filecmp-cmpfiles-params
Jul 18, 2026
Merged

gh-153899: Fix documented parameter names for filecmp.cmpfiles#153900
picnixz merged 2 commits into
python:mainfrom
fedonman:fix-gh-153899-filecmp-cmpfiles-params

Conversation

@fedonman

@fedonman fedonman commented Jul 18, 2026 •
edited by johnslavik
Loading

Copy link
Copy Markdown
Contributor

filecmp.cmpfiles() documents its first two parameters as dir1 and dir2, but the actual signature names them a and b. Calling filecmp.cmpfiles(dir1=..., dir2=..., common=...) therefore raises TypeError. This updates the documentation to match the real parameter names.

Fixes issue #153899.

@fedonman
pythongh-153899: Fix documented parameter names for filecmp.cmpfiles
9909b75 
filecmp.cmpfiles() is documented with parameters named dir1 and dir2,
but the actual parameters are a and b, so the documented keyword names
raise TypeError. Update the documentation to match the real signature.
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Jul 18, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Jul 18, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Jul 18, 2026
Closed
@read-the-docs-community

read-the-docs-community Bot commented Jul 18, 2026 •
edited
Loading

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33645238 | 📁 Comparing 93bc36e against main (7ce9eb1)

  🔍 Preview build  

2 files changed
± library/filecmp.html
± whatsnew/changelog.html

@tomasr8 tomasr8 added the sprint label Jul 18, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Sprint Jul 18, 2026
@github-project-automation github-project-automation Bot moved this from Todo to In Progress in Sprint Jul 18, 2026
@picnixz
picnixz enabled auto-merge (squash) July 18, 2026 10:29
@picnixz picnixz 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 18, 2026
@picnixz
picnixz merged commit 26e7c4f into python:main Jul 18, 2026
40 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Sprint Jul 18, 2026
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Jul 18, 2026
@miss-islington-app

miss-islington-app Bot commented Jul 18, 2026

Copy link
Copy Markdown

Thanks @fedonman for the PR, and @picnixz 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 18, 2026

Copy link
Copy Markdown

GH-153910 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 18, 2026
@bedevere-app

bedevere-app Bot commented Jul 18, 2026

Copy link
Copy Markdown

GH-153911 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 18, 2026
@bedevere-app

bedevere-app Bot commented Jul 18, 2026

Copy link
Copy Markdown

GH-153912 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 18, 2026
picnixz pushed a commit that referenced this pull request Jul 18, 2026
@miss-islington @fedonman
[3.13] gh-153899: Fix documented parameter names for `filecmp.cmpfile…
9b2aca6 
…s` (GH-153900) (#153912)

gh-153899: Fix documented parameter names for `filecmp.cmpfiles` (GH-153900)

Update the `filecmp.cmpfiles()` docs to match its actual signature.
(cherry picked from commit 26e7c4f)

Co-authored-by: Vyron Vasileiadis <hi@fedonman.com>
picnixz pushed a commit that referenced this pull request Jul 18, 2026
@miss-islington @fedonman
[3.14] gh-153899: Fix documented parameter names for `filecmp.cmpfile…
403f6c7 
…s` (GH-153900) (#153911)

gh-153899: Fix documented parameter names for `filecmp.cmpfiles` (GH-153900)

Update the `filecmp.cmpfiles()` docs to match its actual signature.
(cherry picked from commit 26e7c4f)

Co-authored-by: Vyron Vasileiadis <hi@fedonman.com>
picnixz pushed a commit that referenced this pull request Jul 18, 2026
@miss-islington @fedonman
[3.15] gh-153899: Fix documented parameter names for `filecmp.cmpfile…
5825c27 
…s` (GH-153900) (#153910)

gh-153899: Fix documented parameter names for `filecmp.cmpfiles` (GH-153900)

Update the `filecmp.cmpfiles()` docs to match its actual signature.
(cherry picked from commit 26e7c4f)

Co-authored-by: Vyron Vasileiadis <hi@fedonman.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@picnixz picnixz picnixz approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news sprint

Projects

Docs PRs
Status: Done
Sprint
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@fedonman @picnixz @tomasr8