src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/shelve.py

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 9653
e67609152c5e
child 10439
21c28b0f9e41
--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/shelve.py	Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/ShelveExtension/shelve.py	Sat Dec 23 15:40:23 2023 +0100
@@ -26,6 +26,7 @@
         Constructor
 
         @param vcs reference to the Mercurial vcs object
+        @type Hg
         """
         super().__init__(vcs)
 
@@ -44,7 +45,8 @@
         """
         Private method to get the list of shelved changes.
 
-        @return list of shelved changes (list of string)
+        @return list of shelved changes
+        @rtype list of str
         """
         args = self.vcs.initCommand("shelve")
         args.append("--list")
@@ -64,8 +66,10 @@
         Public method to shelve current changes of files or directories.
 
         @param name directory or file name (string) or list of directory
-            or file names (list of string)
-        @return flag indicating that the project should be reread (boolean)
+            or file names
+        @type list of str
+        @return flag indicating that the project should be reread
+        @rtype bool
         """
         from .HgShelveDataDialog import HgShelveDataDialog
 
@@ -118,8 +122,10 @@
         """
         Public method to restore shelved changes to the project directory.
 
-        @param shelveName name of the shelve to restore (string)
-        @return flag indicating that the project should be reread (boolean)
+        @param shelveName name of the shelve to restore
+        @type str
+        @return flag indicating that the project should be reread
+        @rtype bool
         """
         from .HgUnshelveDataDialog import HgUnshelveDataDialog
 
@@ -147,7 +153,8 @@
         """
         Public method to abort the ongoing restore operation.
 
-        @return flag indicating that the project should be reread (boolean)
+        @return flag indicating that the project should be reread
+        @rtype bool
         """
         args = self.vcs.initCommand("unshelve")
         args.append("--abort")
@@ -164,7 +171,8 @@
         """
         Public method to continue the ongoing restore operation.
 
-        @return flag indicating that the project should be reread (boolean)
+        @return flag indicating that the project should be reread
+        @rtype bool
         """
         args = self.vcs.initCommand("unshelve")
         if self.__unshelveKeep:
@@ -183,7 +191,8 @@
         """
         Public method to delete named shelves.
 
-        @param shelveNames name of shelves to delete (list of string)
+        @param shelveNames name of shelves to delete
+        @type list of str
         """
         from .HgShelvesSelectionDialog import HgShelvesSelectionDialog
 

eric ide

mercurial