Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html	Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.hg.html	Sat Dec 23 15:40:23 2023 +0100
@@ -564,17 +564,17 @@
 </p>
 <dl>
 
-<dt><i>plugin</i></dt>
+<dt><i>plugin</i> (VcsMercurialPlugin)</dt>
 <dd>
 reference to the plugin object
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget (QWidget)
+parent widget
 </dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of this object (string)
+name of this object
 </dd>
 </dl>
 <a NAME="Hg.__checkDefaults" ID="Hg.__checkDefaults"></a>
@@ -615,15 +615,21 @@
 </p>
 <dl>
 
-<dt><i>incoming</i></dt>
+<dt><i>incoming</i> (bool)</dt>
 <dd>
-flag indicating to get incoming bookmarks (boolean)
+flag indicating to get incoming bookmarks
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of bookmarks (list of string)
+list of bookmarks
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Hg.__getMostRecentCommitMessage" ID="Hg.__getMostRecentCommitMessage"></a>
@@ -659,19 +665,25 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file name to get from the repository (string)
+file name to get from the repository
 </dd>
-<dt><i>rev</i></dt>
+<dt><i>rev</i> (str)</dt>
 <dd>
-revision to retrieve (string)
+revision to retrieve
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-contents of the file (string) and an error message (string)
+contents of the file (string) and an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Hg.__hgGraftSubCommand" ID="Hg.__hgGraftSubCommand"></a>
@@ -713,9 +725,9 @@
 </p>
 <dl>
 
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
-name of the changed file (string)
+name of the changed file
 </dd>
 </dl>
 <a NAME="Hg.__monitorRepoIniFile" ID="Hg.__monitorRepoIniFile"></a>
@@ -750,20 +762,25 @@
 </p>
 <dl>
 
-<dt><i>interval</i></dt>
+<dt><i>interval</i> (int)</dt>
 <dd>
 check interval for the monitor thread in seconds
-            (integer)
 </dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
-reference to the project object (Project)
+reference to the project object
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the monitor thread (QThread)
+reference to the monitor thread
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+HgStatusMonitorThread
 </dd>
 </dl>
 <a NAME="Hg.canCommitMerge" ID="Hg.canCommitMerge"></a>
@@ -796,7 +813,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating pull capability (boolean)
+flag indicating pull capability
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Hg.canPush" ID="Hg.canPush"></a>
@@ -809,7 +832,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating push capability (boolean)
+flag indicating push capability
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Hg.clearStatusCache" ID="Hg.clearStatusCache"></a>
@@ -829,7 +858,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the client (HgClient)
+reference to the client
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+HgClient
 </dd>
 </dl>
 <a NAME="Hg.getEncoding" ID="Hg.getEncoding"></a>
@@ -842,7 +877,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-encoding (string)
+encoding
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Hg.getExtensionObject" ID="Hg.getExtensionObject"></a>
@@ -854,15 +895,21 @@
 </p>
 <dl>
 
-<dt><i>extensionName</i></dt>
+<dt><i>extensionName</i> (str)</dt>
 <dd>
-name of the extension (string)
+name of the extension
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the extension object (boolean)
+reference to the extension object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Hg.getHgSubPath" ID="Hg.getHgSubPath"></a>
@@ -876,7 +923,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-full path of the .hgsub file (string)
+full path of the .hgsub file
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Hg.getPlugin" ID="Hg.getPlugin"></a>
@@ -889,7 +942,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the plugin object (VcsMercurialPlugin)
+reference to the plugin object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+VcsMercurialPlugin
 </dd>
 </dl>
 <a NAME="Hg.hasSubrepositories" ID="Hg.hasSubrepositories"></a>
@@ -902,7 +961,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating the existence of sub-repositories (boolean)
+flag indicating the existence of sub-repositories
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Hg.hgAbortMerge" ID="Hg.hgAbortMerge"></a>
@@ -915,8 +980,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating, that the abortion contained an add
-            or delete (boolean)
+flag indicating, that the abortion contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Hg.hgAddSubrepository" ID="Hg.hgAddSubrepository"></a>
@@ -990,13 +1060,13 @@
 </p>
 <dl>
 
-<dt><i>revision</i></dt>
+<dt><i>revision</i> (str)</dt>
 <dd>
-revision to set bookmark for (string)
+revision to set bookmark for
 </dd>
-<dt><i>bookmark</i></dt>
+<dt><i>bookmark</i> (str)</dt>
 <dd>
-name of the bookmark (string)
+name of the bookmark
 </dd>
 </dl>
 <a NAME="Hg.hgBookmarkDelete" ID="Hg.hgBookmarkDelete"></a>
@@ -1008,9 +1078,9 @@
 </p>
 <dl>
 
-<dt><i>bookmark</i></dt>
+<dt><i>bookmark</i> (str)</dt>
 <dd>
-name of the bookmark (string)
+name of the bookmark
 </dd>
 </dl>
 <a NAME="Hg.hgBookmarkIncoming" ID="Hg.hgBookmarkIncoming"></a>
@@ -1029,13 +1099,13 @@
 </p>
 <dl>
 
-<dt><i>revision</i></dt>
+<dt><i>revision</i> (str)</dt>
 <dd>
-revision to set bookmark for (string)
+revision to set bookmark for
 </dd>
-<dt><i>bookmark</i></dt>
+<dt><i>bookmark</i> (str)</dt>
 <dd>
-name of the bookmark (string)
+name of the bookmark
 </dd>
 </dl>
 <a NAME="Hg.hgBookmarkOutgoing" ID="Hg.hgBookmarkOutgoing"></a>
@@ -1136,11 +1206,11 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be copied (string)
+file/directory name to be copied
 </dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
 reference to the project object
 </dd>
@@ -1148,7 +1218,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating successful operation (boolean)
+flag indicating successful operation
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Hg.hgCreateIgnoreFile" ID="Hg.hgCreateIgnoreFile"></a>
@@ -1160,13 +1236,13 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-directory name to create the ignore file in (string)
+directory name to create the ignore file in
 </dd>
-<dt><i>autoAdd</i></dt>
+<dt><i>autoAdd</i> (bool)</dt>
 <dd>
-flag indicating to add it automatically (boolean)
+flag indicating to add it automatically
 </dd>
 </dl>
 <dl>
@@ -1175,6 +1251,12 @@
 flag indicating success
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <a NAME="Hg.hgDeleteBackups" ID="Hg.hgDeleteBackups"></a>
 <h4>Hg.hgDeleteBackups</h4>
 <b>hgDeleteBackups</b>(<i></i>)
@@ -1239,9 +1321,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be diffed (string)
+file/directory name to be diffed
 </dd>
 </dl>
 <a NAME="Hg.hgGetBookmarksList" ID="Hg.hgGetBookmarksList"></a>
@@ -1254,7 +1336,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of bookmarks (list of string)
+list of bookmarks
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Hg.hgGetBranchesList" ID="Hg.hgGetBranchesList"></a>
@@ -1318,17 +1406,22 @@
 </p>
 <dl>
 
-<dt><i>withType</i></dt>
+<dt><i>withType</i> (bool)</dt>
 <dd>
-flag indicating to get the tag type as well (boolean)
+flag indicating to get the tag type as well
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of tags (list of string) or list of tuples of
-            tag name and flag indicating a local tag (list of tuple of string
-            and boolean), if withType is True
+list of tags or list of tuples of tag name and flag indicating
+            a local tag, if withType is True
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str or list of [(str, bool)]
 </dd>
 </dl>
 <a NAME="Hg.hgGraft" ID="Hg.hgGraft"></a>
@@ -1340,16 +1433,21 @@
 </p>
 <dl>
 
-<dt><i>revs</i></dt>
+<dt><i>revs</i> (list of str)</dt>
 <dd>
-list of revisions to show in the revisions pane (list of
-            strings)
+list of revisions to show in the revisions pane
 </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>
 <a NAME="Hg.hgGraftAbort" ID="Hg.hgGraftAbort"></a>
@@ -1428,7 +1526,13 @@
 <dt>Return:</dt>
 <dd>
 flag indicating, that the import contained an add, a delete
-            or a change to the project file (boolean)
+            or a change to the project file
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Hg.hgIncoming" ID="Hg.hgIncoming"></a>
@@ -1448,10 +1552,9 @@
 </p>
 <dl>
 
-<dt><i>mode</i></dt>
+<dt><i>mode</i> (str)</dt>
 <dd>
-mode of the operation (string, one of heads, parents,
-            tip)
+mode of the operation (one of 'heads', 'parents', 'tip')
 </dd>
 </dl>
 <a NAME="Hg.hgListBookmarks" ID="Hg.hgListBookmarks"></a>
@@ -1470,10 +1573,10 @@
 </p>
 <dl>
 
-<dt><i>tags</i></dt>
+<dt><i>tags</i> (bool)</dt>
 <dd>
 flag indicating listing of branches or tags
-                (False = branches, True = tags)
+            (False = branches, True = tags)
 </dd>
 </dl>
 <a NAME="Hg.hgNormalizeURL" ID="Hg.hgNormalizeURL"></a>
@@ -1485,15 +1588,21 @@
 </p>
 <dl>
 
-<dt><i>url</i></dt>
+<dt><i>url</i> (str)</dt>
 <dd>
-url string (string)
+url string
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-properly normalized url for mercurial (string)
+properly normalized url for mercurial
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Hg.hgOutgoing" ID="Hg.hgOutgoing"></a>
@@ -1513,16 +1622,22 @@
 </p>
 <dl>
 
-<dt><i>data</i></dt>
+<dt><i>data</i> (tuple of (list of str, str, bool))</dt>
 <dd>
 tuple giving phase data (list of revisions, phase, flag
-            indicating a forced operation) (list of strings, string, boolean)
+            indicating a forced operation)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <dl>
@@ -1576,17 +1691,17 @@
 </p>
 <dl>
 
-<dt><i>force</i></dt>
+<dt><i>force</i> (bool)</dt>
 <dd>
-flag indicating a forced push (boolean)
+flag indicating a forced push
 </dd>
-<dt><i>newBranch</i></dt>
+<dt><i>newBranch</i> (bool)</dt>
 <dd>
-flag indicating to push a new branch (boolean)
+flag indicating to push a new branch
 </dd>
-<dt><i>rev</i></dt>
+<dt><i>rev</i> (str)</dt>
 <dd>
-revision to be pushed (including all ancestors) (string)
+revision to be pushed (including all ancestors)
 </dd>
 </dl>
 <a NAME="Hg.hgReMerge" ID="Hg.hgReMerge"></a>
@@ -1598,9 +1713,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be merged (string)
+file/directory name to be merged
 </dd>
 </dl>
 <a NAME="Hg.hgRecover" ID="Hg.hgRecover"></a>
@@ -1669,14 +1784,14 @@
 </p>
 <dl>
 
-<dt><i>mq</i></dt>
+<dt><i>mq</i> (bool)</dt>
 <dd>
-flag indicating to show the queue status as well (boolean)
+flag indicating to show the queue status as well
 </dd>
-<dt><i>largefiles</i></dt>
+<dt><i>largefiles</i> (bool)</dt>
 <dd>
 flag indicating to show the largefiles status as
-            well (boolean)
+            well
 </dd>
 </dl>
 <a NAME="Hg.hgUnbundle" ID="Hg.hgUnbundle"></a>
@@ -1722,15 +1837,21 @@
 </p>
 <dl>
 
-<dt><i>command</i></dt>
+<dt><i>command</i> (str)</dt>
 <dd>
-command name (string)
+command name
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of command options (list of string)
+list of command options
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="Hg.isExtensionActive" ID="Hg.isExtensionActive"></a>
@@ -1742,15 +1863,21 @@
 </p>
 <dl>
 
-<dt><i>extensionName</i></dt>
+<dt><i>extensionName</i> (str)</dt>
 <dd>
-name of the extension to check for (string)
+name of the extension to check for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating an active extension (boolean)
+flag indicating an active extension
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Hg.stopClient" ID="Hg.stopClient"></a>
@@ -1769,15 +1896,15 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be added (string)
+file/directory name to be added
 </dd>
-<dt><i>isDir</i></dt>
+<dt><i>isDir</i> (bool)</dt>
 <dd>
-flag indicating name is a directory (boolean)
+flag indicating name is a directory
 </dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
 <dd>
 flag indicating quiet operations
 </dd>
@@ -1792,13 +1919,13 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be added (string)
+file/directory name to be added
 </dd>
-<dt><i>isDir</i></dt>
+<dt><i>isDir</i> (bool)</dt>
 <dd>
-flag indicating name is a directory (boolean)
+flag indicating name is a directory
 </dd>
 </dl>
 <a NAME="Hg.vcsAddCommitMessage" ID="Hg.vcsAddCommitMessage"></a>
@@ -1825,10 +1952,9 @@
 </p>
 <dl>
 
-<dt><i>path</i></dt>
+<dt><i>path</i> (str or list of str)</dt>
 <dd>
-root directory of the tree to be added (string or list of
-            strings))
+root directory of the tree to be added
 </dd>
 </dl>
 <a NAME="Hg.vcsAllRegisteredStates" ID="Hg.vcsAllRegisteredStates"></a>
@@ -1846,17 +1972,17 @@
 </p>
 <dl>
 
-<dt><i>names</i></dt>
+<dt><i>names</i> (dict)</dt>
 <dd>
 dictionary with all filenames to be checked as keys
 </dd>
-<dt><i>dname</i></dt>
+<dt><i>dname</i> (str)</dt>
 <dd>
-directory to check in (string)
+directory to check in
 </dd>
-<dt><i>shortcut</i></dt>
+<dt><i>shortcut</i> (bool)</dt>
 <dd>
-flag indicating a shortcut should be taken (boolean)
+flag indicating a shortcut should be taken
 </dd>
 </dl>
 <dl>
@@ -1866,6 +1992,12 @@
             canBeCommited and canBeAdded or None in order to signal an error
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
 <a NAME="Hg.vcsCheckout" ID="Hg.vcsCheckout"></a>
 <h4>Hg.vcsCheckout</h4>
 <b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
@@ -1876,15 +2008,15 @@
 </p>
 <dl>
 
-<dt><i>vcsDataDict</i></dt>
+<dt><i>vcsDataDict</i> (dict)</dt>
 <dd>
 dictionary of data required for the checkout
 </dd>
-<dt><i>projectDir</i></dt>
+<dt><i>projectDir</i> (str)</dt>
 <dd>
-project directory to create (string)
+project directory to create
 </dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
 <dd>
 flag indicating quiet operations
 </dd>
@@ -1892,7 +2024,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating an execution without errors (boolean)
+flag indicating an execution without errors
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Hg.vcsCleanup" ID="Hg.vcsCleanup"></a>
@@ -1904,9 +2042,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-directory name to be cleaned up (string)
+directory name to be cleaned up
 </dd>
 </dl>
 <a NAME="Hg.vcsClearCommitMessages" ID="Hg.vcsClearCommitMessages"></a>
@@ -1925,9 +2063,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-directory name of the working directory (string)
+directory name of the working directory
 </dd>
 </dl>
 <a NAME="Hg.vcsCommit" ID="Hg.vcsCommit"></a>
@@ -1940,30 +2078,29 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str or list of str)</dt>
 <dd>
-file/directory name to be committed (string or list of
-            strings)
+file/directory name to be committed
 </dd>
-<dt><i>message</i></dt>
+<dt><i>message</i> (str)</dt>
 <dd>
-message for this operation (string)
+message for this operation
 </dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
 <dd>
 flag indicating quiet operations
 </dd>
-<dt><i>closeBranch</i></dt>
+<dt><i>closeBranch</i> (bool)</dt>
 <dd>
-flag indicating a close branch commit (boolean)
+flag indicating a close branch commit
 </dd>
-<dt><i>mq</i></dt>
+<dt><i>mq</i> (bool)</dt>
 <dd>
-flag indicating a queue commit (boolean)
+flag indicating a queue commit
 </dd>
-<dt><i>merge</i></dt>
+<dt><i>merge</i> (bool)</dt>
 <dd>
-flag indicating a merge commit (boolean)
+flag indicating a merge commit
 </dd>
 </dl>
 <a NAME="Hg.vcsCommitMessages" ID="Hg.vcsCommitMessages"></a>
@@ -2024,9 +2161,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be diffed (string)
+file/directory name to be diffed
 </dd>
 </dl>
 <a NAME="Hg.vcsExists" ID="Hg.vcsExists"></a>
@@ -2039,8 +2176,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating the existence (boolean) and an error message
-            (string)
+flag indicating the existence and an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
 </dd>
 </dl>
 <a NAME="Hg.vcsExport" ID="Hg.vcsExport"></a>
@@ -2052,19 +2194,25 @@
 </p>
 <dl>
 
-<dt><i>vcsDataDict</i></dt>
+<dt><i>vcsDataDict</i> (dict)</dt>
 <dd>
 dictionary of data required for the checkout
 </dd>
-<dt><i>projectDir</i></dt>
+<dt><i>projectDir</i> (str)</dt>
 <dd>
-project directory to create (string)
+project directory to create
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating an execution without errors (boolean)
+flag indicating an execution without errors
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Hg.vcsForget" ID="Hg.vcsForget"></a>
@@ -2094,15 +2242,15 @@
 </p>
 <dl>
 
-<dt><i>browser</i></dt>
+<dt><i>browser</i> (ProjectBaseBrowser)</dt>
 <dd>
 reference to the project browser object
 </dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
 reference to the project object
 </dd>
-<dt><i>isTranslationsBrowser</i></dt>
+<dt><i>isTranslationsBrowser</i> (bool)</dt>
 <dd>
 flag indicating, the helper is requested
             for the translations browser (this needs some special treatment)
@@ -2114,6 +2262,12 @@
 the project browser helper object
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+HgProjectBrowserHelper
+</dd>
+</dl>
 <a NAME="Hg.vcsGetProjectHelper" ID="Hg.vcsGetProjectHelper"></a>
 <h4>Hg.vcsGetProjectHelper</h4>
 <b>vcsGetProjectHelper</b>(<i>project</i>)
@@ -2123,7 +2277,7 @@
 </p>
 <dl>
 
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
 reference to the project object
 </dd>
@@ -2134,6 +2288,12 @@
 the project helper object
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+HgProjectHelper
+</dd>
+</dl>
 <a NAME="Hg.vcsImport" ID="Hg.vcsImport"></a>
 <h4>Hg.vcsImport</h4>
 <b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>)
@@ -2149,7 +2309,7 @@
 </dd>
 <dt><i>projectDir</i> (str)</dt>
 <dd>
-project directory (string)
+project directory
 </dd>
 <dt><i>noDialog</i> (bool)</dt>
 <dd>
@@ -2187,19 +2347,25 @@
 </p>
 <dl>
 
-<dt><i>vcsDir</i></dt>
+<dt><i>vcsDir</i> (str)</dt>
 <dd>
-name of the VCS directory (string)
+name of the VCS directory
 </dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
 <dd>
-flag indicating quiet operations (boolean)
+flag indicating quiet operations
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-always TRUE
+always True
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Hg.vcsInitConfig" ID="Hg.vcsInitConfig"></a>
@@ -2214,9 +2380,9 @@
 </p>
 <dl>
 
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
-reference to the project (Project)
+reference to the project
 </dd>
 </dl>
 <a NAME="Hg.vcsLogBrowser" ID="Hg.vcsLogBrowser"></a>
@@ -2229,14 +2395,13 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to show the log of (string)
+file/directory name to show the log of
 </dd>
-<dt><i>isFile</i></dt>
+<dt><i>isFile</i> (bool)</dt>
 <dd>
 flag indicating log for a file is to be shown
-            (boolean)
 </dd>
 </dl>
 <a NAME="Hg.vcsMerge" ID="Hg.vcsMerge"></a>
@@ -2266,19 +2431,19 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be moved (string)
+file/directory name to be moved
 </dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
 reference to the project object
 </dd>
-<dt><i>target</i></dt>
+<dt><i>target</i> (str)</dt>
 <dd>
-new name of the file/directory (string)
+new name of the file/directory
 </dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
 <dd>
 flag indicating quiet operations
 </dd>
@@ -2286,7 +2451,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating successfull operation (boolean)
+flag indicating successfull operation
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Hg.vcsName" ID="Hg.vcsName"></a>
@@ -2299,7 +2470,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-always 'Mercurial' (string)
+always 'Mercurial'
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Hg.vcsNewProjectOptionsDialog" ID="Hg.vcsNewProjectOptionsDialog"></a>
@@ -2312,16 +2489,21 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget (QWidget)
+parent widget
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
 reference to the instantiated options dialog
-            (HgNewProjectOptionsDialog)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+HgNewProjectOptionsDialog
 </dd>
 </dl>
 <a NAME="Hg.vcsOptionsDialog" ID="Hg.vcsOptionsDialog"></a>
@@ -2333,28 +2515,33 @@
 </p>
 <dl>
 
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
 reference to the project object
 </dd>
-<dt><i>archive</i></dt>
+<dt><i>archive</i> (str)</dt>
 <dd>
-name of the project in the repository (string)
+name of the project in the repository
 </dd>
-<dt><i>editable</i></dt>
+<dt><i>editable</i> (bool)</dt>
 <dd>
 flag indicating that the project name is editable
-            (boolean)
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget (QWidget)
+parent widget
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the instantiated options dialog (HgOptionsDialog)
+reference to the instantiated options dialog
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+HgOptionsDialog
 </dd>
 </dl>
 <a NAME="Hg.vcsRegisteredState" ID="Hg.vcsRegisteredState"></a>
@@ -2374,7 +2561,7 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-a combination of canBeCommited and canBeAdded
+registered state (one of canBeCommited and canBeAdded)
 </dd>
 </dl>
 <dl>
@@ -2396,17 +2583,15 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str or list of str)</dt>
 <dd>
-file/directory name to be removed (string or list of
-            strings))
+file/directory name to be removed
 </dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (bool)</dt>
 <dd>
-flag indicating deletion of a project tree (boolean)
-            (not needed)
+flag indicating deletion of a project tree
 </dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
 <dd>
 flag indicating quiet operations
 </dd>
@@ -2414,7 +2599,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating successfull operation (boolean)
+flag indicating successfull operation
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Hg.vcsRepositoryInfos" ID="Hg.vcsRepositoryInfos"></a>
@@ -2426,15 +2617,21 @@
 </p>
 <dl>
 
-<dt><i>ppath</i></dt>
+<dt><i>ppath</i> (str)</dt>
 <dd>
-local path to get the repository infos (string)
+local path to get the repository infos
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-string with ready formated info for display (string)
+string with ready formated info for display
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Hg.vcsResolved" ID="Hg.vcsResolved"></a>
@@ -2446,14 +2643,14 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file/directory name to be resolved (string)
+file/directory name to be resolved
 </dd>
-<dt><i>unresolve</i></dt>
+<dt><i>unresolve</i> (bool)</dt>
 <dd>
 flag indicating to mark the file/directory as
-            unresolved (boolean)
+            unresolved
 </dd>
 </dl>
 <a NAME="Hg.vcsRevert" ID="Hg.vcsRevert"></a>
@@ -2493,17 +2690,17 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-file name to be diffed (string)
+file name to be diffed
 </dd>
-<dt><i>extended</i></dt>
+<dt><i>extended</i> (bool)</dt>
 <dd>
-flag indicating the extended variant (boolean)
+flag indicating the extended variant
 </dd>
-<dt><i>revisions</i></dt>
+<dt><i>revisions</i> (tuple of (str, str))</dt>
 <dd>
-tuple of two revisions (tuple of strings)
+tuple of two revisions
 </dd>
 </dl>
 <dl>
@@ -2530,10 +2727,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str or list of str)</dt>
 <dd>
 file/directory name(s) to show the status of
-            (string or list of strings)
 </dd>
 </dl>
 <a NAME="Hg.vcsSupportCommandOptions" ID="Hg.vcsSupportCommandOptions"></a>
@@ -2547,7 +2743,12 @@
 <dt>Return:</dt>
 <dd>
 flag indicating the support  of user settable command options
-            (boolean)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Hg.vcsSwitch" ID="Hg.vcsSwitch"></a>
@@ -2560,16 +2761,21 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-directory name to be switched (string)
+directory name to be switched
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating, that the switch contained an add
-            or delete (boolean)
+flag indicating, that the switch contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Hg.vcsTag" ID="Hg.vcsTag"></a>
@@ -2581,24 +2787,29 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
 file/directory name to determine the repo root from
-            (string)
 </dd>
-<dt><i>revision</i></dt>
+<dt><i>revision</i> (str)</dt>
 <dd>
-revision to set tag for (string)
+revision to set tag for
 </dd>
-<dt><i>tagName</i></dt>
+<dt><i>tagName</i> (str)</dt>
 <dd>
-name of the tag (string)
+name of the tag
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating a performed tag action (boolean)
+flag indicating a performed tag action
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="Hg.vcsUpdate" ID="Hg.vcsUpdate"></a>
@@ -2611,24 +2822,29 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
 file/directory name to be updated (not used)
 </dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
 <dd>
-flag indicating quiet operations (boolean)
+flag indicating quiet operations
 </dd>
-<dt><i>revision</i></dt>
+<dt><i>revision</i> (str)</dt>
 <dd>
-revision to update to (string)
+revision to update to
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating, that the update contained an add
-            or delete (boolean)
+flag indicating, that the update contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>