Mercurial Repositories > eric / changeset
changeset
Changed some code documentation from '@ireturn' to '@return'.
Sat, 24 Aug 2019 18:24:33 +0200
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Sat, 24 Aug 2019 18:24:33 +0200
- changeset 7165
- 375c077ef7e2
- parent 7164
- 6da6a0a5a448
- child 7166
- 5a184952ba77
Changed some code documentation from '@ireturn' to '@return'.
--- a/eric6/Helpviewer/Network/SchemeAccessHandler.py Sat Aug 24 16:33:42 2019 +0200 +++ b/eric6/Helpviewer/Network/SchemeAccessHandler.py Sat Aug 24 18:24:33 2019 +0200 @@ -33,7 +33,7 @@ @param request reference to the request object (QNetworkRequest) @param outgoingData reference to an IODevice containing data to be sent (QIODevice) - @ireturn reference to the created reply object (QNetworkReply) + @return reference to the created reply object (QNetworkReply) @exception NotImplementedError raised to indicate that the method must be implemented by a subclass """
--- a/eric6/Helpviewer/WebPlugins/WebPluginInterface.py Sat Aug 24 16:33:42 2019 +0200 +++ b/eric6/Helpviewer/WebPlugins/WebPluginInterface.py Sat Aug 24 18:24:33 2019 +0200 @@ -19,7 +19,7 @@ """ Public method to create a meta plug-in object containing plug-in info. - @ireturn meta plug-in object (QWebPluginFactory.Plugin) + @return meta plug-in object (QWebPluginFactory.Plugin) @exception NotImplementedError raised to indicate that this method must be implemented by subclasses """ @@ -33,7 +33,7 @@ @param url URL for the plug-in (QUrl) @param argumentNames list of argument names (list of strings) @param argumentValues list of argument values (list of strings) - @ireturn reference to the created object (QWidget) + @return reference to the created object (QWidget) @exception NotImplementedError raised to indicate that this method must be implemented by subclasses """
--- a/eric6/Plugins/VcsPlugins/vcsMercurial/HgExtensionProjectBrowserHelper.py Sat Aug 24 16:33:42 2019 +0200 +++ b/eric6/Plugins/VcsPlugins/vcsMercurial/HgExtensionProjectBrowserHelper.py Sat Aug 24 18:24:33 2019 +0200 @@ -41,7 +41,7 @@ Note: Derived class must implement this method. - @ireturn dictionary of populated menu (dict of QMenu). The dict + @return dictionary of populated menu (dict of QMenu). The dict must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' and 'dirMultiMenu'. @exception NotImplementedError raised if the class has not been @@ -55,7 +55,7 @@ Note: Derived class must implement this method. - @ireturn title of the menu (string) + @return title of the menu (string) @exception NotImplementedError raised if the class has not been reimplemented """
--- a/eric6/Plugins/VcsPlugins/vcsMercurial/HgExtensionProjectHelper.py Sat Aug 24 16:33:42 2019 +0200 +++ b/eric6/Plugins/VcsPlugins/vcsMercurial/HgExtensionProjectHelper.py Sat Aug 24 18:24:33 2019 +0200 @@ -66,7 +66,7 @@ Note: Derived class must implement this method. @param mainMenu reference to the main menu (QMenu) - @ireturn populated menu (QMenu) + @return populated menu (QMenu) @exception NotImplementedError raised if the class has not been reimplemented """ @@ -78,7 +78,7 @@ Note: Derived class must implement this method. - @ireturn title of the menu (string) + @return title of the menu (string) @exception NotImplementedError raised if the class has not been reimplemented """
--- a/eric6/VCS/StatusMonitorThread.py Sat Aug 24 16:33:42 2019 +0200 +++ b/eric6/VCS/StatusMonitorThread.py Sat Aug 24 18:24:33 2019 +0200 @@ -197,7 +197,7 @@ <li>" " path is back at normal</li> </ul> - @ireturn tuple of flag indicating successful operation (boolean) and + @return tuple of flag indicating successful operation (boolean) and a status message in case of non successful operation (string) @exception RuntimeError to indicate that this method must be implemented by a subclass
--- a/eric6/ViewManager/ViewManager.py Sat Aug 24 16:33:42 2019 +0200 +++ b/eric6/ViewManager/ViewManager.py Sat Aug 24 18:24:33 2019 +0200 @@ -334,7 +334,7 @@ """ Public method to signal if cascading of managed windows is available. - @ireturn flag indicating cascading of windows is available + @return flag indicating cascading of windows is available @exception RuntimeError Not implemented """ raise RuntimeError('Not implemented') @@ -343,7 +343,7 @@ """ Public method to signal if tiling of managed windows is available. - @ireturn flag indicating tiling of windows is available + @return flag indicating tiling of windows is available @exception RuntimeError Not implemented """ raise RuntimeError('Not implemented') @@ -368,7 +368,7 @@ """ Public method to return the active (i.e. current) window. - @ireturn reference to the active editor + @return reference to the active editor @exception RuntimeError Not implemented """ raise RuntimeError('Not implemented')
