[Pkg-bazaar-commits] ./bzr/unstable r619: doc

[Martin Pool]

------------------------------------------------------------
revno: 619
committer: Martin Pool <mbp at sourcefrog.net>
timestamp: Thu 2005-06-02 12:37:54 +1000
message:
  doc
modified:
  bzrlib/diff.py
-------------- next part --------------
=== modified file 'bzrlib/diff.py'
--- a/bzrlib/diff.py	2005-05-30 01:39:13 +0000
+++ b/bzrlib/diff.py	2005-06-02 02:37:54 +0000
@@ -148,6 +148,17 @@
 
 
 def show_diff(b, revision, specific_files, external_diff_options=None):
+    """Shortcut for showing the diff to the working tree.
+
+    b
+        Branch.
+
+    revision
+        None for each, or otherwise the old revision to compare against.
+    
+    The more general form is show_diff_trees(), where the caller
+    supplies any two trees.
+    """
     import sys
 
     if revision == None: