Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html	Mon Sep 25 12:09:23 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html	Tue Sep 26 18:26:21 2023 +0200
@@ -1259,15 +1259,35 @@
 </dl>
 <a NAME="Hg.hgGetBranchesList" ID="Hg.hgGetBranchesList"></a>
 <h4>Hg.hgGetBranchesList</h4>
-<b>hgGetBranchesList</b>(<i></i>)
+<b>hgGetBranchesList</b>(<i>withState=False, withDefault=False</i>)
 
 <p>
         Public method to get the list of branches.
 </p>
 <dl>
+
+<dt><i>withState</i> (bool (optional))</dt>
+<dd>
+flag indicating to include a state indication (defaults to
+            False)
+</dd>
+<dt><i>withDefault</i> (bool (optional))</dt>
+<dd>
+flag indicating to include the 'default' branch, if that
+            is present (defaults to False)
+</dd>
+</dl>
+<dl>
 <dt>Return:</dt>
 <dd>
-list of branches (list of string)
+list of branches with optional state indication ('' for an active
+            branch, 'C' for a closed branch or 'I' for an inactive branch)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str or list of tuple of (str, str)
 </dd>
 </dl>
 <a NAME="Hg.hgGetCurrentBranch" ID="Hg.hgGetCurrentBranch"></a>