src/eric7/Plugins/VcsPlugins/vcsMercurial/HgDiffGenerator.py

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 9653
e67609152c5e
child 10439
21c28b0f9e41
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgDiffGenerator.py	Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgDiffGenerator.py	Sat Dec 23 15:40:23 2023 +0100
@@ -28,7 +28,9 @@
         Constructor
 
         @param vcs reference to the vcs object
-        @param parent parent widget (QWidget)
+        @type Hg
+        @param parent parent widget
+        @type QWidget
         """
         super().__init__(parent)
 
@@ -47,8 +49,10 @@
         """
         Private method to get a hg revision argument for the given revision.
 
-        @param version revision (integer or string)
-        @return version argument (string)
+        @param version revision
+        @type int or str
+        @return version argument
+        @rtype str
         """
         if version == "WORKING":
             return None
@@ -59,13 +63,16 @@
         """
         Public slot to start the hg diff command.
 
-        @param fn filename to be diffed (string)
-        @param versions list of versions to be diffed (list of up to
-            2 strings or None)
-        @param bundle name of a bundle file (string)
-        @param qdiff flag indicating qdiff command shall be used (boolean)
+        @param fn filename to be diffed
+        @type str
+        @param versions list of versions to be diffed
+        @type list of up to 2 str or None
+        @param bundle name of a bundle file
+        @type str
+        @param qdiff flag indicating qdiff command shall be used
+        @type bool
         @return flag indicating a successful start of the diff command
-            (boolean)
+        @rtype bool
         """
         if qdiff:
             args = self.vcs.initCommand("qdiff")
@@ -144,9 +151,9 @@
         """
         Public method to return the result data.
 
-        @return tuple of lists of string containing lines of the diff, the
-            list of errors and a list of tuples of filenames and the line
-            into the diff output.
+        @return tuple containing a list of lines of the diff, a list of errors
+            and a list of tuples of filenames and the line into the diff output
+        @rtype tuple of (list of str, list of str, list of tuple of (str, int))
         """
         return (self.__output, self.__errors, self.__fileSeparators)
 
@@ -154,8 +161,10 @@
         """
         Private method to extract the file name out of a file separator line.
 
-        @param line line to be processed (string)
-        @return extracted file name (string)
+        @param line line to be processed
+        @type str
+        @return extracted file name
+        @rtype str
         """
         f = line.split(None, 1)[1]
         f = f.rsplit(None, 6)[0]

eric ide

mercurial