src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnDialogMixin.py

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 9653
e67609152c5e
child 10439
21c28b0f9e41
diff -r 2f70ca07f0af -r 4cd7e5a8b3cf src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnDialogMixin.py
--- a/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnDialogMixin.py	Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Plugins/VcsPlugins/vcsPySvn/SvnDialogMixin.py	Sat Dec 23 15:40:23 2023 +0100
@@ -23,7 +23,8 @@
         """
         Constructor
 
-        @param log optional log message (string)
+        @param log optional log message
+        @type str
         """
         self.shouldCancel = False
         self.logMessage = log
@@ -45,6 +46,7 @@
         Protected method called by the client to check for cancellation.
 
         @return flag indicating a cancellation
+        @rtype bool
         """
         QApplication.processEvents()
         return self.shouldCancel
@@ -53,15 +55,19 @@
         """
         Protected method called by the client to get login information.
 
-        @param realm name of the realm of the requested credentials (string)
-        @param username username as supplied by subversion (string)
+        @param realm name of the realm of the requested credentials
+        @type str
+        @param username username as supplied by subversion
+        @type str
         @param may_save flag indicating, that subversion is willing to save
-            the answers returned (boolean)
+            the answers returned
+        @type bool
         @return tuple of four values (retcode, username, password, save).
             Retcode should be True, if username and password should be used
             by subversion, username and password contain the relevant data
             as strings and save is a flag indicating, that username and
             password should be saved.
+        @rtype tuple of (bool, str, str, bool)
         """
         from .SvnLoginDialog import SvnLoginDialog
 
@@ -82,10 +88,12 @@
         ssl server certificate.
 
         @param trust_dict dictionary containing the trust data
+        @type dict
         @return tuple of three values (retcode, acceptedFailures, save).
-            Retcode should be true, if the certificate should be accepted,
+            Retcode should be True, if the certificate should be accepted,
             acceptedFailures should indicate the accepted certificate failures
             and save should be True, if subversion should save the certificate.
+        @rtype tuple of (bool, list of str, bool)
         """
         from eric7.EricWidgets import EricMessageBox
 
@@ -135,7 +143,8 @@
         """
         Protected method called by the client to request a log message.
 
-        @return a flag indicating success and the log message (string)
+        @return a flag indicating success and the log message
+        @rtype str
         """
         from .SvnCommitDialog import SvnCommitDialog
 

eric ide

mercurial