Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html	Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html	Sat Dec 23 15:40:23 2023 +0100
@@ -182,7 +182,7 @@
 </p>
 <dl>
 
-<dt><i>vcs</i></dt>
+<dt><i>vcs</i> (Hg)</dt>
 <dd>
 reference to the Mercurial vcs object
 </dd>
@@ -197,7 +197,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-name of the current patch (string)
+name of the current patch
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Queues.__getCurrentPatch" ID="Queues.__getCurrentPatch"></a>
@@ -210,7 +216,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-name of the current patch (string)
+name of the current patch
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Queues.__getPatchesList" ID="Queues.__getPatchesList"></a>
@@ -222,20 +234,26 @@
 </p>
 <dl>
 
-<dt><i>listType</i></dt>
+<dt><i>listType</i> (int)</dt>
 <dd>
 type of patches list to get
             (Queues.APPLIED_LIST, Queues.UNAPPLIED_LIST, Queues.SERIES_LIST)
 </dd>
-<dt><i>withSummary</i></dt>
+<dt><i>withSummary</i> (bool)</dt>
 <dd>
-flag indicating to get a summary as well (boolean)
+flag indicating to get a summary as well
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of patches (list of string)
+list of patches
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <dl>
@@ -254,15 +272,21 @@
 </p>
 <dl>
 
-<dt><i>allGuards</i></dt>
+<dt><i>allGuards</i> (bool)</dt>
 <dd>
-flag indicating to get all guards (boolean)
+flag indicating to get all guards
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-sorted list of guards (list of strings)
+sorted list of guards
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Queues.hgQueueCreateRenameQueue" ID="Queues.hgQueueCreateRenameQueue"></a>
@@ -274,9 +298,9 @@
 </p>
 <dl>
 
-<dt><i>isCreate</i></dt>
+<dt><i>isCreate</i> (bool)</dt>
 <dd>
-flag indicating to create a new queue (boolean)
+flag indicating to create a new queue
 </dd>
 </dl>
 <a NAME="Queues.hgQueueDeletePatch" ID="Queues.hgQueueDeletePatch"></a>
@@ -296,7 +320,7 @@
 </p>
 <dl>
 
-<dt><i>operation</i></dt>
+<dt><i>operation</i> (int)</dt>
 <dd>
 operation to be performed (Queues.QUEUE_DELETE,
             Queues.QUEUE_PURGE, Queues.QUEUE_ACTIVATE)
@@ -410,29 +434,35 @@
 </p>
 <dl>
 
-<dt><i>operation</i></dt>
+<dt><i>operation</i> (int)</dt>
 <dd>
 operation type to be performed (Queues.POP,
             Queues.PUSH, Queues.GOTO)
 </dd>
-<dt><i>doAll</i></dt>
+<dt><i>doAll</i> (bool)</dt>
 <dd>
-flag indicating to push/pop all (boolean)
+flag indicating to push/pop all
 </dd>
-<dt><i>named</i></dt>
+<dt><i>named</i> (bool)</dt>
 <dd>
 flag indicating to push/pop until a named patch
-            is at the top of the stack (boolean)
+            is at the top of the stack
 </dd>
-<dt><i>force</i></dt>
+<dt><i>force</i> (bool)</dt>
 <dd>
-flag indicating a forceful pop (boolean)
+flag indicating a forceful pop
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating that the project should be reread (boolean)
+flag indicating that the project should be reread
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <dl>
@@ -451,10 +481,10 @@
 </p>
 <dl>
 
-<dt><i>editMessage</i></dt>
+<dt><i>editMessage</i> (bool)</dt>
 <dd>
 flag indicating to edit the current
-            commit message (boolean)
+            commit message
 </dd>
 </dl>
 <a NAME="Queues.hgQueueRenamePatch" ID="Queues.hgQueueRenamePatch"></a>
@@ -480,9 +510,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name (string)
+file/directory name
 </dd>
 </dl>
 <a NAME="Queues.hgQueueStatus" ID="Queues.hgQueueStatus"></a>
@@ -494,9 +524,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-directory name (string)
+directory name
 </dd>
 </dl>
 <a NAME="Queues.shutdown" ID="Queues.shutdown"></a>