diff -r 866adc8c315b -r 0acf98cd089a eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.shelve.html --- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.shelve.html Sun Jan 17 13:53:08 2021 +0100 +++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.shelve.html Mon Feb 01 10:38:16 2021 +0100 @@ -131,51 +131,33 @@ </dl> <a NAME="Shelve.__hgGetShelveNamesList" ID="Shelve.__hgGetShelveNamesList"></a> <h4>Shelve.__hgGetShelveNamesList</h4> -<b>__hgGetShelveNamesList</b>(<i>repodir</i>) +<b>__hgGetShelveNamesList</b>(<i></i>) <p> Private method to get the list of shelved changes. </p> <dl> - -<dt><i>repodir</i></dt> -<dd> -directory name of the repository (string) -</dd> -</dl> -<dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> list of shelved changes (list of string) </dd> </dl> <a NAME="Shelve.hgCleanupShelves" ID="Shelve.hgCleanupShelves"></a> <h4>Shelve.hgCleanupShelves</h4> -<b>hgCleanupShelves</b>(<i>name</i>) +<b>hgCleanupShelves</b>(<i></i>) <p> Public method to delete all shelves. </p> -<dl> - -<dt><i>name</i></dt> -<dd> -name of the project directory (string) -</dd> -</dl> <a NAME="Shelve.hgDeleteShelves" ID="Shelve.hgDeleteShelves"></a> <h4>Shelve.hgDeleteShelves</h4> -<b>hgDeleteShelves</b>(<i>name, shelveNames=None</i>) +<b>hgDeleteShelves</b>(<i>shelveNames=None</i>) <p> Public method to delete named shelves. </p> <dl> -<dt><i>name</i></dt> -<dd> -name of the project directory (string) -</dd> <dt><i>shelveNames</i></dt> <dd> name of shelves to delete (list of string) @@ -197,85 +179,60 @@ </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating that the project should be reread (boolean) </dd> </dl> <a NAME="Shelve.hgShelveBrowser" ID="Shelve.hgShelveBrowser"></a> <h4>Shelve.hgShelveBrowser</h4> -<b>hgShelveBrowser</b>(<i>projectDir</i>) +<b>hgShelveBrowser</b>(<i></i>) <p> Public method to show the shelve browser dialog. </p> -<dl> - -<dt><i>projectDir</i></dt> -<dd> -name of the project directory (string) -</dd> -</dl> <a NAME="Shelve.hgUnshelve" ID="Shelve.hgUnshelve"></a> <h4>Shelve.hgUnshelve</h4> -<b>hgUnshelve</b>(<i>name, shelveName=""</i>) +<b>hgUnshelve</b>(<i>shelveName=""</i>) <p> Public method to restore shelved changes to the project directory. </p> <dl> -<dt><i>name</i></dt> -<dd> -name of the project directory (string) -</dd> -<dt><i>shelveName=</i></dt> +<dt><i>shelveName</i></dt> <dd> name of the shelve to restore (string) </dd> </dl> <dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating that the project should be reread (boolean) </dd> </dl> <a NAME="Shelve.hgUnshelveAbort" ID="Shelve.hgUnshelveAbort"></a> <h4>Shelve.hgUnshelveAbort</h4> -<b>hgUnshelveAbort</b>(<i>name</i>) +<b>hgUnshelveAbort</b>(<i></i>) <p> Public method to abort the ongoing restore operation. </p> <dl> - -<dt><i>name</i></dt> -<dd> -name of the project directory (string) -</dd> -</dl> -<dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating that the project should be reread (boolean) </dd> </dl> <a NAME="Shelve.hgUnshelveContinue" ID="Shelve.hgUnshelveContinue"></a> <h4>Shelve.hgUnshelveContinue</h4> -<b>hgUnshelveContinue</b>(<i>name</i>) +<b>hgUnshelveContinue</b>(<i></i>) <p> Public method to continue the ongoing restore operation. </p> <dl> - -<dt><i>name</i></dt> -<dd> -name of the project directory (string) -</dd> -</dl> -<dl> -<dt>Returns:</dt> +<dt>Return:</dt> <dd> flag indicating that the project should be reread (boolean) </dd>