]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.15] gh-153899: Fix documented parameter names for `filecmp.cmpfiles` (GH-153900...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sat, 18 Jul 2026 10:42:53 +0000 (12:42 +0200)
committerGitHub <noreply@github.com>
Sat, 18 Jul 2026 10:42:53 +0000 (10:42 +0000)
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 26e7c4fe3f68668abbc96fc4ac57c2d5ef8048b5)

Co-authored-by: Vyron Vasileiadis <hi@fedonman.com>
Doc/library/filecmp.rst

index f8365b44c5a502da6afb41df905d29557b8a105e..4488322032c681a27b64d8447b22ea0aac519a4e 100644 (file)
@@ -34,9 +34,9 @@ The :mod:`!filecmp` module defines the following functions:
    file changes.  The entire cache may be cleared using :func:`clear_cache`.
 
 
-.. function:: cmpfiles(dir1, dir2, common, shallow=True)
+.. function:: cmpfiles(a, b, common, shallow=True)
 
-   Compare the files in the two directories *dir1* and *dir2* whose names are
+   Compare the files in the two directories *a* and *b* whose names are
    given by *common*.
 
    Returns three lists of file names: *match*, *mismatch*,