Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.hg.html

changeset 2966
f85f686981ad
parent 2845
7e55c6268c35
child 3018
70924c0bdaf1
--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.hg.html	Sun Sep 29 18:22:08 2013 +0200
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.hg.html	Sun Sep 29 18:23:27 2013 +0200
@@ -428,12 +428,12 @@
 <p>
         Protected method to create an instance of the VCS status monitor thread.
 </p><dl>
-<dt><i>project</i></dt>
+<dt><i>interval</i></dt>
+<dd>
+check interval for the monitor thread in seconds (integer)
+</dd><dt><i>project</i></dt>
 <dd>
 reference to the project object (Project)
-</dd><dt><i>interval</i></dt>
-<dd>
-check interval for the monitor thread in seconds (integer)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
@@ -545,6 +545,11 @@
 name of the subcommand (string, one of 'good', 'bad',
             'skip' or 'reset')
 </dd>
+</dl><dl>
+<dt>Raises <b>ValueError</b>:</dt>
+<dd>
+raised to indicate an invalid bisect subcommand
+</dd>
 </dl><a NAME="Hg.hgBranch" ID="Hg.hgBranch"></a>
 <h4>Hg.hgBranch</h4>
 <b>hgBranch</b>(<i>name</i>)
@@ -851,6 +856,11 @@
 <dd>
 flag indicating success (boolean)
 </dd>
+</dl><dl>
+<dt>Raises <b>ValueError</b>:</dt>
+<dd>
+raised to indicate an invalid phase
+</dd>
 </dl><a NAME="Hg.hgPreviewBundle" ID="Hg.hgPreviewBundle"></a>
 <h4>Hg.hgPreviewBundle</h4>
 <b>hgPreviewBundle</b>(<i>name</i>)
@@ -962,6 +972,11 @@
 <dd>
 tuple of two revisions (tuple of strings)
 </dd>
+</dl><dl>
+<dt>Raises <b>ValueError</b>:</dt>
+<dd>
+raised to indicate an invalid name parameter
+</dd>
 </dl><a NAME="Hg.hgServe" ID="Hg.hgServe"></a>
 <h4>Hg.hgServe</h4>
 <b>hgServe</b>(<i>name</i>)
@@ -1391,12 +1406,19 @@
 <h4>Hg.vcsNewProjectOptionsDialog</h4>
 <b>vcsNewProjectOptionsDialog</b>(<i>parent=None</i>)
 <p>
-        Public method to get a dialog to enter repository info for getting a new project.
+        Public method to get a dialog to enter repository info for getting a
+        new project.
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
 parent widget (QWidget)
 </dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the instantiated options dialog
+            (HgNewProjectOptionsDialog)
+</dd>
 </dl><a NAME="Hg.vcsOptionsDialog" ID="Hg.vcsOptionsDialog"></a>
 <h4>Hg.vcsOptionsDialog</h4>
 <b>vcsOptionsDialog</b>(<i>project, archive, editable=False, parent=None</i>)
@@ -1411,11 +1433,17 @@
 name of the project in the repository (string)
 </dd><dt><i>editable</i></dt>
 <dd>
-flag indicating that the project name is editable (boolean)
+flag indicating that the project name is editable
+            (boolean)
 </dd><dt><i>parent</i></dt>
 <dd>
 parent widget (QWidget)
 </dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the instantiated options dialog (HgOptionsDialog)
+</dd>
 </dl><a NAME="Hg.vcsRegisteredState" ID="Hg.vcsRegisteredState"></a>
 <h4>Hg.vcsRegisteredState</h4>
 <b>vcsRegisteredState</b>(<i>name</i>)

eric ide

mercurial