This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Documentation of filecmp.compfiles missing word & possible explanation
Type: Stage:
Components: Documentation Versions: Python 3.0, Python 3.1, Python 2.7, Python 2.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: MLModel, georg.brandl, tarek
Priority: normal Keywords:

Created on 2009-02-25 05:52 by MLModel, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (2)
msg82696 - (view) Author: Mitchell Model (MLModel) Date: 2009-02-25 05:52
"contains the list of files match in both directories," should have 
"that" before "match"

In addition I couldn't figure out from the documentation what "common" 
was supposed to be doing -- it sounded more like something that should 
be part of the result not a parameter. I had to look at the code to 
realize that this function ONLY compares the files listed in common -- 
that it doesn't compare two directories completely, but rather dir1 and 
dir2 are merely prefixes for the files listed in common that are to be 
compared.

One thing that would help would be to move the paragraph about common 
first. Another would be to "a list of file names found in both 
directories" to "a list of the names of files to be compared, which must 
be in both directories" or something like that.
msg82838 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-02-27 16:40
That was really a suboptimal documentation :)

I reworded it and added an example in r70023. (I suspect it's still not
as clear as if the actual five lines of implementation were given ;)
History
Date User Action Args
2022-04-11 14:56:46adminsetgithub: 49613
2009-02-27 16:40:26georg.brandlsetstatus: open -> closed
assignee: tarek -> georg.brandl
resolution: fixed
messages: + msg82838
nosy: + georg.brandl
2009-02-25 05:52:11MLModelsetcomponents: + Documentation, - Distutils
2009-02-25 05:52:03MLModelcreate