--- a/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/queues.py Fri Dec 22 19:45:17 2023 +0100 +++ b/src/eric7/Plugins/VcsPlugins/vcsMercurial/QueuesExtension/queues.py Sat Dec 23 15:40:23 2023 +0100 @@ -37,6 +37,7 @@ Constructor @param vcs reference to the Mercurial vcs object + @type Hg """ super().__init__(vcs) @@ -76,8 +77,11 @@ @param listType type of patches list to get (Queues.APPLIED_LIST, Queues.UNAPPLIED_LIST, Queues.SERIES_LIST) - @param withSummary flag indicating to get a summary as well (boolean) - @return list of patches (list of string) + @type int + @param withSummary flag indicating to get a summary as well + @type bool + @return list of patches + @rtype list of str @exception ValueError raised to indicate an invalid patch list type """ patchesList = [] @@ -119,7 +123,8 @@ """ Private method to get the name of the current patch. - @return name of the current patch (string) + @return name of the current patch + @rtype str """ currentPatch = "" @@ -134,7 +139,8 @@ """ Private method to get the commit message of the current patch. - @return name of the current patch (string) + @return name of the current patch + @rtype str """ message = "" @@ -149,8 +155,10 @@ """ Public method to get a list of all guards defined. - @param allGuards flag indicating to get all guards (boolean) - @return sorted list of guards (list of strings) + @param allGuards flag indicating to get all guards + @type bool + @return sorted list of guards + @rtype list of str """ guardsList = [] @@ -214,7 +222,8 @@ Public method to refresh the current patch. @param editMessage flag indicating to edit the current - commit message (boolean) + commit message + @type bool """ from .HgQueuesNewPatchDialog import HgQueuesNewPatchDialog @@ -260,7 +269,8 @@ """ Public method to show the contents of the current patch. - @param name file/directory name (string) + @param name file/directory name + @type str """ from ..HgDiffDialog import HgDiffDialog @@ -287,11 +297,16 @@ @param operation operation type to be performed (Queues.POP, Queues.PUSH, Queues.GOTO) - @param doAll flag indicating to push/pop all (boolean) + @type int + @param doAll flag indicating to push/pop all + @type bool @param named flag indicating to push/pop until a named patch - is at the top of the stack (boolean) - @param force flag indicating a forceful pop (boolean) - @return flag indicating that the project should be reread (boolean) + is at the top of the stack + @type bool + @param force flag indicating a forceful pop + @type bool + @return flag indicating that the project should be reread + @rtype bool @exception ValueError raised to indicate an invalid operation """ if operation not in (Queues.POP, Queues.PUSH, Queues.GOTO): @@ -593,7 +608,8 @@ """ Public method to create a new queue or rename the active queue. - @param isCreate flag indicating to create a new queue (boolean) + @param isCreate flag indicating to create a new queue + @type bool """ from .HgQueuesQueueManagementDialog import HgQueuesQueueManagementDialog @@ -638,6 +654,7 @@ @param operation operation to be performed (Queues.QUEUE_DELETE, Queues.QUEUE_PURGE, Queues.QUEUE_ACTIVATE) + @type int @exception ValueError raised to indicate an invalid operation """ from .HgQueuesQueueManagementDialog import HgQueuesQueueManagementDialog @@ -720,7 +737,8 @@ """ Public method used to view the status of a queue repository. - @param name directory name (string) + @param name directory name + @type str """ from ..HgStatusDialog import HgStatusDialog