Skip to content

Commit 98ef356

Browse files
author
Joseph Yu
committed
Using tuple() syntax
1 parent dd745c8 commit 98ef356

File tree

1 file changed

+11
-17
lines changed

1 file changed

+11
-17
lines changed

python/tank/platform/engine.py

+11-17
Original file line numberDiff line numberDiff line change
@@ -1835,9 +1835,7 @@ def show_dialog(self, title, bundle, widget_class, *args, **kwargs):
18351835
The dialog will be created with a standard Toolkit window title bar where
18361836
the title will be displayed.
18371837
1838-
.. seealso::
1839-
- :ref:`qdialog-exit-codes`
1840-
- :ref:`hiding-toolkit-title-bar`
1838+
.. seealso:: :ref:`hiding-toolkit-title-bar`
18411839
18421840
**Notes for engine developers**
18431841
@@ -1907,7 +1905,9 @@ def show_modal(self, title, bundle, widget_class, *args, **kwargs):
19071905
the title will be displayed.
19081906
19091907
.. seealso::
1908+
19101909
- :ref:`qdialog-exit-codes`
1910+
19111911
- :ref:`hiding-toolkit-title-bar`
19121912
19131913
:param title: The title of the window
@@ -1918,10 +1918,9 @@ def show_modal(self, title, bundle, widget_class, *args, **kwargs):
19181918
Additional parameters specified will be passed through to the
19191919
``widget_class`` constructor.
19201920
1921-
:returns: Tuple of :attr:`QDialog.DialogCode
1922-
<PySide.QtGui.PySide.QtGui.QDialog.DialogCode>` and and the created
1923-
``widget_class`` instance
1924-
:rtype: (:class:`int`, :class:`PySide.QtGui.QWidget`)
1921+
:returns: :attr:`QDialog.DialogCode <PySide.QtGui.PySide.QtGui.QDialog.DialogCode>`
1922+
and the created ``widget_class`` instance
1923+
:rtype: tuple(int, PySide.QtGui.QWidget)
19251924
"""
19261925
if not self.has_ui:
19271926
self.log_error(
@@ -1954,24 +1953,19 @@ def show_panel(self, panel_id, title, bundle, widget_class, *args, **kwargs):
19541953
The dialog will be created with a standard Toolkit window title bar where
19551954
the title will be displayed.
19561955
1957-
.. note:: In some cases, it is necessary to hide the standard Toolkit title
1958-
bar. You can do this by adding a property to the widget class you are
1959-
displaying::
1960-
1961-
@property
1962-
def hide_tk_title_bar(self):
1963-
"Tell the system to not show the standard toolkit toolbar"
1964-
return True
1956+
.. seealso:: :ref:`hiding-toolkit-title-bar`
19651957
19661958
:param panel_id: Unique identifier for the panel, as obtained by register_panel().
19671959
:param title: The title of the panel
19681960
:param bundle: The app, engine or framework object that is associated with this window
19691961
:param widget_class: The class of the UI to be constructed. This must derive from QWidget.
19701962
:type widget_class: :class:`PySide.QtGui.QWidget`
19711963
1972-
Additional parameters specified will be passed through to the widget_class constructor.
1964+
Additional parameters specified will be passed through to the
1965+
``widget_class`` constructor.
19731966
1974-
:returns: the created widget_class instance
1967+
:returns: The created ``widget_class`` instance
1968+
:rtype: PySide.QtGui.QWidget
19751969
"""
19761970
# engines implementing panel support should subclass this method.
19771971
# the core implementation falls back on a modeless window.

0 commit comments

Comments
 (0)