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

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 9653
e67609152c5e
child 10439
21c28b0f9e41
diff -r 2f70ca07f0af -r 4cd7e5a8b3cf src/eric7/Plugins/VcsPlugins/vcsMercurial/HgStatusDialog.py
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgStatusDialog.py	Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/HgStatusDialog.py	Sat Dec 23 15:40:23 2023 +0100
@@ -41,8 +41,11 @@
         Constructor
 
         @param vcs reference to the vcs object
-        @param mq flag indicating to show a queue repo status (boolean)
-        @param parent parent widget (QWidget)
+        @type Hg
+        @param mq flag indicating to show a queue repo status
+        @type bool
+        @param parent parent widget
+        @type QWidget
         """
         super().__init__(parent)
         self.setupUi(self)
@@ -220,7 +223,8 @@
         """
         Protected slot implementing a close event handler.
 
-        @param e close event (QCloseEvent)
+        @param e close event
+        @type QCloseEvent
         """
         if self.__hgClient.isExecuting():
             self.__hgClient.cancel()
@@ -286,8 +290,10 @@
         """
         Private method to generate a status item in the status list.
 
-        @param status status indicator (string)
-        @param path path of the file or directory (string)
+        @param status status indicator
+        @type str
+        @param path path of the file or directory
+        @type str
         """
         statusText = self.status[status]
         itm = QTreeWidgetItem(
@@ -316,7 +322,7 @@
         Public slot to start the hg status command.
 
         @param fn filename(s)/directoryname(s) to show the status of
-            (string or list of strings)
+        @type str or list of str
         """
         self.errorGroup.hide()
         self.intercept = False
@@ -389,7 +395,8 @@
         """
         Private slot called by a button of the button box clicked.
 
-        @param button button that was clicked (QAbstractButton)
+        @param button button that was clicked
+        @type QAbstractButton
         """
         if button == self.buttonBox.button(QDialogButtonBox.StandardButton.Close):
             self.close()
@@ -402,7 +409,8 @@
         """
         Private method to process the lines of output.
 
-        @param line output line to be processed (string)
+        @param line output line to be processed
+        @type str
         """
         if line[0] in "ACIMR?!" and line[1] == " ":
             status, path = line.strip().split(" ", 1)
@@ -412,7 +420,8 @@
         """
         Private slot to show some error.
 
-        @param out error to be shown (string)
+        @param out error to be shown
+        @type str
         """
         self.errorGroup.show()
         self.errors.insertPlainText(out)
@@ -581,7 +590,8 @@
         """
         Private slot to add a file to the repository.
 
-        @param mode add mode (string one of 'normal' or 'large')
+        @param mode add mode (one of 'normal' or 'large')
+        @type str
         """
         names = [
             os.path.join(self.__repoPath, itm.text(self.__pathColumn))
@@ -724,6 +734,7 @@
         Private method to retrieve all entries the user wants to commit.
 
         @return list of all items, the user has checked
+        @rtype list of QTreeWidgetItems
         """
         commitableItems = []
         for index in range(self.statusList.topLevelItemCount()):
@@ -738,6 +749,7 @@
         selected.
 
         @return list of all items, the user has checked
+        @rtype list of QTreeWidgetItems
         """
         items = []
         for index in range(self.statusList.topLevelItemCount()):
@@ -754,6 +766,7 @@
         Private method to retrieve all entries, that have a modified status.
 
         @return list of all items with a modified status
+        @rtype list of QTreeWidgetItems
         """
         modifiedItems = []
         for itm in self.statusList.selectedItems():
@@ -767,6 +780,7 @@
         status.
 
         @return list of all items with an unversioned status
+        @rtype list of QTreeWidgetItems
         """
         unversionedItems = []
         for itm in self.statusList.selectedItems():
@@ -779,6 +793,7 @@
         Private method to retrieve all entries, that have a missing status.
 
         @return list of all items with a missing status
+        @rtype list of QTreeWidgetItems
         """
         missingItems = []
         for itm in self.statusList.selectedItems():
@@ -790,7 +805,8 @@
         """
         Private slot to select or deselect all entries.
 
-        @param selected commit selection state to be set (boolean)
+        @param selected commit selection state to be set
+        @type bool
         """
         for index in range(self.statusList.topLevelItemCount()):
             itm = self.statusList.topLevelItem(index)

eric ide

mercurial