diff options
| author | Carlos Pascual <cpascual@cells.es> | 2021-06-15 11:12:18 +0200 |
|---|---|---|
| committer | Carlos Pascual <cpascual@cells.es> | 2021-06-15 11:12:18 +0200 |
| commit | e19248e93aa71ca9f17e7994ebece38d7665e97d (patch) | |
| tree | 9d23d97aa3ea6e981826974a9dec58b05b8dd0d6 /lib/taurus/qt/qtdesigner | |
| parent | d01dfd960c5f8f061fc304121700182f947f31f4 (diff) | |
Reformat all docstring from taurus style to reST
Most docstrings in taurus use a custom style in which types are
given in parenthesis. This is not so convenient since one cannot
make use of standard tools for auto-formatting (e.g. sphinx's
napoleon, or pycharm autocompletes, ...)
Run taurusdoc2rest.py + black on the taurus root dir to reformat.
This also rewraps some parts of the docstrings, removing many
of flake8's E501 warnings (long lines).
Diffstat (limited to 'lib/taurus/qt/qtdesigner')
| -rw-r--r-- | lib/taurus/qt/qtdesigner/__init__.py | 3 | ||||
| -rw-r--r-- | lib/taurus/qt/qtdesigner/taurusplugin/__init__.py | 3 | ||||
| -rw-r--r-- | lib/taurus/qt/qtdesigner/taurusplugin/taurusplugin.py | 9 |
3 files changed, 10 insertions, 5 deletions
diff --git a/lib/taurus/qt/qtdesigner/__init__.py b/lib/taurus/qt/qtdesigner/__init__.py index 749bf1ba..8598334d 100644 --- a/lib/taurus/qt/qtdesigner/__init__.py +++ b/lib/taurus/qt/qtdesigner/__init__.py @@ -23,6 +23,7 @@ ## ############################################################################# -"""The taurus.qt.qtdesigner submodule. It contains qt-specific part of taurus""" +"""The taurus.qt.qtdesigner submodule. It contains qt-specific part of taurus +""" __docformat__ = "restructuredtext" diff --git a/lib/taurus/qt/qtdesigner/taurusplugin/__init__.py b/lib/taurus/qt/qtdesigner/taurusplugin/__init__.py index 6164789c..9f49b0b6 100644 --- a/lib/taurus/qt/qtdesigner/taurusplugin/__init__.py +++ b/lib/taurus/qt/qtdesigner/taurusplugin/__init__.py @@ -23,7 +23,8 @@ ## ############################################################################# -"""The taurus.qt.qtdesigner.taurusplugin submodule.""" +"""The taurus.qt.qtdesigner.taurusplugin submodule. +""" __docformat__ = "restructuredtext" diff --git a/lib/taurus/qt/qtdesigner/taurusplugin/taurusplugin.py b/lib/taurus/qt/qtdesigner/taurusplugin/taurusplugin.py index 37b1eeba..02a979e1 100644 --- a/lib/taurus/qt/qtdesigner/taurusplugin/taurusplugin.py +++ b/lib/taurus/qt/qtdesigner/taurusplugin/taurusplugin.py @@ -63,7 +63,8 @@ class TaurusWidgetPlugin(QtDesigner.QPyDesignerCustomWidgetPlugin): def initialize(self, formEditor): """Overwrite if necessary. Don't forget to call this method in case you - want the generic taurus extensions in your widget.""" + want the generic taurus extensions in your widget. + """ if self.isInitialized(): return @@ -131,7 +132,8 @@ class TaurusWidgetPlugin(QtDesigner.QPyDesignerCustomWidgetPlugin): def group(self): """Returns the name of the group in Qt Designer's widget box that this widget belongs to. - It returns 'Taurus Widgets'. Overwrite if want another group.""" + It returns 'Taurus Widgets'. Overwrite if want another group. + """ return self.getWidgetInfo("group", "Taurus Widgets") def getIconName(self): @@ -155,7 +157,8 @@ class TaurusWidgetPlugin(QtDesigner.QPyDesignerCustomWidgetPlugin): def includeFile(self): """Returns the module containing the custom widget class. It may include - a module path.""" + a module path. + """ return self.getWidgetInfo("module") def toolTip(self): |