Mercurial Repositories > eric / file diff

--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnCommitDialog.py	Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnCommitDialog.py	Sat Dec 23 15:40:23 2023 +0100
@@ -33,7 +33,9 @@
         Constructor
 
         @param vcs reference to the vcs object
-        @param parent parent widget (QWidget)
+        @type Subversion
+        @param parent parent widget
+        @type QWidget
         """
         super().__init__(parent, Qt.WindowType.Window)
         self.setupUi(self)
@@ -54,7 +56,8 @@
         """
         Protected method called when the dialog is about to be shown.
 
-        @param evt the event (QShowEvent)
+        @param evt the event
+        @type QShowEvent
         """
         commitMessages = self.__vcs.vcsCommitMessages()
         self.recentComboBox.clear()
@@ -70,7 +73,8 @@
         This method has the side effect of saving the 20 most recent
         commit messages for reuse.
 
-        @return the log message (string)
+        @return the log message
+        @rtype str
         """
         msg = self.logEdit.toPlainText()
         if msg:
@@ -79,18 +83,20 @@
 
     def hasChangelists(self):
         """
-        Public method to check, if the user entered some changelists.
+        Public method to check, if the user entered some change lists.
 
-        @return flag indicating availability of changelists (boolean)
+        @return flag indicating availability of change lists
+        @rtype bool
         """
         return len(self.changeLists.selectedItems()) > 0
 
     def changelistsData(self):
         """
-        Public method to retrieve the changelists data.
+        Public method to retrieve the change lists data.
 
-        @return tuple containing the changelists (list of strings) and a flag
-            indicating to keep changelists (boolean)
+        @return tuple containing the change lists and a flag indicating to keep
+            the change lists
+        @rtype tuple of (list of str, bool)
         """
         slists = [
             line.text().strip()
@@ -107,7 +113,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.Cancel):
             self.logEdit.clear()