[meld/VersionControlRework: 112/123] vcview: Improve some docstring



commit 0769bde000cdcb715b8761e0560cad51d1a28cf2
Author: Kai Willadsen <kai willadsen gmail com>
Date:   Sat Apr 18 09:44:55 2015 +1000

    vcview: Improve some docstring

 meld/vcview.py |    7 +++++--
 1 files changed, 5 insertions(+), 2 deletions(-)
---
diff --git a/meld/vcview.py b/meld/vcview.py
index 7a55f0c..96ca2a4 100644
--- a/meld/vcview.py
+++ b/meld/vcview.py
@@ -564,8 +564,11 @@ class VcView(melddoc.MeldDoc, gnomeglade.Component):
         return [x[-1] != "/" and x or x[:-1] for x in sel if x is not None]
 
     def _command_iter(self, command, files, refresh, working_dir):
-        """Run 'command' on 'files'. Return a tuple of the directory the
-           command was executed in and the output of the command.
+        """An iterable that runs a VC command on a set of files
+
+        This method is intended to be used as a scheduled task, with
+        standard out and error output displayed in this view's
+        consolestream.
         """
 
         def shelljoin(command):


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]