diff options
| author | Georg Brandl <georg@python.org> | 2009-05-17 12:29:12 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2009-05-17 12:29:12 (GMT) |
| commit | 71515ca191f32651c923c70e891632b4ac820b4f (patch) | |
| tree | d6694e4aabe615b76ca113374bf35cd817fca330 /Doc/library/filecmp.rst | |
| parent | ef0a865f9c906a1298c43a453b2195d86befd6a4 (diff) | |
| download | cpython-71515ca191f32651c923c70e891632b4ac820b4f.zip cpython-71515ca191f32651c923c70e891632b4ac820b4f.tar.gz cpython-71515ca191f32651c923c70e891632b4ac820b4f.tar.bz2 | |
Remove surplus empty lines and convert more files to new optional arg style.
Diffstat (limited to 'Doc/library/filecmp.rst')
| -rw-r--r-- | Doc/library/filecmp.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/library/filecmp.rst b/Doc/library/filecmp.rst index 11d74ba..f57dcce 100644 --- a/Doc/library/filecmp.rst +++ b/Doc/library/filecmp.rst @@ -1,4 +1,3 @@ - :mod:`filecmp` --- File and Directory Comparisons ================================================= @@ -14,7 +13,7 @@ see also the :mod:`difflib` module. The :mod:`filecmp` module defines the following functions: -.. function:: cmp(f1, f2[, shallow]) +.. function:: cmp(f1, f2, shallow=True) Compare the files named *f1* and *f2*, returning ``True`` if they seem equal, ``False`` otherwise. @@ -29,7 +28,7 @@ The :mod:`filecmp` module defines the following functions: portability and efficiency. -.. function:: cmpfiles(dir1, dir2, common[, shallow]) +.. function:: cmpfiles(dir1, dir2, common, shallow=True) Compare the files in the two directories *dir1* and *dir2* whose names are given by *common*. @@ -66,7 +65,7 @@ The :class:`dircmp` class :class:`dircmp` instances are built using this constructor: -.. class:: dircmp(a, b[, ignore[, hide]]) +.. class:: dircmp(a, b, ignore=None, hide=None) Construct a new directory comparison object, to compare the directories *a* and *b*. *ignore* is a list of names to ignore, and defaults to ``['RCS', 'CVS', @@ -159,5 +158,6 @@ The :class:`dircmp` class .. attribute:: subdirs - A dictionary mapping names in :attr:`common_dirs` to :class:`dircmp` objects. + A dictionary mapping names in :attr:`common_dirs` to :class:`dircmp` + objects. |