summaryrefslogtreecommitdiffstats
path: root/Doc/library/filecmp.rst
diff options
context:
space:
mode:
authorBenjamin Peterson <benjamin@python.org>2008-04-25 01:59:09 (GMT)
committerBenjamin Peterson <benjamin@python.org>2008-04-25 01:59:09 (GMT)
commite41251e864e94885d785b5a9bf8f824753316296 (patch)
treef530db7682d71f4920b22b8d7f84c89727647ab5 /Doc/library/filecmp.rst
parent768db92b438038586c1580b711c528363a97d3f4 (diff)
downloadcpython-e41251e864e94885d785b5a9bf8f824753316296.zip
cpython-e41251e864e94885d785b5a9bf8f824753316296.tar.gz
cpython-e41251e864e94885d785b5a9bf8f824753316296.tar.bz2
Merged revisions 62490 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r62490 | benjamin.peterson | 2008-04-24 20:29:10 -0500 (Thu, 24 Apr 2008) | 2 lines reformat some documentation of classes so methods and attributes are under the class directive ........
Diffstat (limited to 'Doc/library/filecmp.rst')
-rw-r--r--Doc/library/filecmp.rst77
1 files changed, 40 insertions, 37 deletions
diff --git a/Doc/library/filecmp.rst b/Doc/library/filecmp.rst
index 141889e..3377d97 100644
--- a/Doc/library/filecmp.rst
+++ b/Doc/library/filecmp.rst
@@ -66,88 +66,91 @@ The :class:`dircmp` class
'tags']``. *hide* is a list of names to hide, and defaults to ``[os.curdir,
os.pardir]``.
-The :class:`dircmp` class provides the following methods:
+ The :class:`dircmp` class provides the following methods:
-.. method:: dircmp.report()
+ .. method:: report()
- Print (to ``sys.stdout``) a comparison between *a* and *b*.
+ Print (to ``sys.stdout``) a comparison between *a* and *b*.
-.. method:: dircmp.report_partial_closure()
+ .. method:: report_partial_closure()
- Print a comparison between *a* and *b* and common immediate subdirectories.
+ Print a comparison between *a* and *b* and common immediate
+ subdirectories.
-.. method:: dircmp.report_full_closure()
+ .. method:: report_full_closure()
- Print a comparison between *a* and *b* and common subdirectories (recursively).
+ Print a comparison between *a* and *b* and common subdirectories
+ (recursively).
-The :class:`dircmp` offers a number of interesting attributes that may be used
-to get various bits of information about the directory trees being compared.
+ The :class:`dircmp` offers a number of interesting attributes that may be
+ used to get various bits of information about the directory trees being
+ compared.
-Note that via :meth:`__getattr__` hooks, all attributes are computed lazily, so
-there is no speed penalty if only those attributes which are lightweight to
-compute are used.
+ Note that via :meth:`__getattr__` hooks, all attributes are computed lazily,
+ so there is no speed penalty if only those attributes which are lightweight
+ to compute are used.
-.. attribute:: dircmp.left_list
+ .. attribute:: left_list
- Files and subdirectories in *a*, filtered by *hide* and *ignore*.
+ Files and subdirectories in *a*, filtered by *hide* and *ignore*.
-.. attribute:: dircmp.right_list
+ .. attribute:: right_list
- Files and subdirectories in *b*, filtered by *hide* and *ignore*.
+ Files and subdirectories in *b*, filtered by *hide* and *ignore*.
-.. attribute:: dircmp.common
+ .. attribute:: common
- Files and subdirectories in both *a* and *b*.
+ Files and subdirectories in both *a* and *b*.
-.. attribute:: dircmp.left_only
+ .. attribute:: left_only
- Files and subdirectories only in *a*.
+ Files and subdirectories only in *a*.
-.. attribute:: dircmp.right_only
+ .. attribute:: right_only
- Files and subdirectories only in *b*.
+ Files and subdirectories only in *b*.
-.. attribute:: dircmp.common_dirs
+ .. attribute:: common_dirs
- Subdirectories in both *a* and *b*.
+ Subdirectories in both *a* and *b*.
-.. attribute:: dircmp.common_files
+ .. attribute:: common_files
- Files in both *a* and *b*
+ Files in both *a* and *b*
-.. attribute:: dircmp.common_funny
+ .. attribute:: common_funny
- Names in both *a* and *b*, such that the type differs between the directories,
- or names for which :func:`os.stat` reports an error.
+ Names in both *a* and *b*, such that the type differs between the
+ directories, or names for which :func:`os.stat` reports an error.
-.. attribute:: dircmp.same_files
+ .. attribute:: same_files
- Files which are identical in both *a* and *b*.
+ Files which are identical in both *a* and *b*.
-.. attribute:: dircmp.diff_files
+ .. attribute:: diff_files
- Files which are in both *a* and *b*, whose contents differ.
+ Files which are in both *a* and *b*, whose contents differ.
-.. attribute:: dircmp.funny_files
+ .. attribute:: funny_files
- Files which are in both *a* and *b*, but could not be compared.
+ Files which are in both *a* and *b*, but could not be compared.
-.. attribute:: dircmp.subdirs
+ .. 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.