Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dschreij committed Aug 9, 2016
1 parent 7950101 commit 49b797a
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions QOpenScienceFramework/manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,9 @@ def progress_icon(self):

@progress_icon.setter
def progress_icon(self, val):
""" The icon to show on the progress dialog. Should be a QIcon. """
if not isinstance(val, QtGui.QIcon):
raise TypeError('progress_icon should be a QIcon')
""" The icon to show on the progress dialog."""
if not isinstance(val, QtGui.QIcon) and not val is None:
raise TypeError('progress_icon should be a QtGui.QIcon or None')
self._progress_icon = val

### Private functions
Expand Down Expand Up @@ -857,18 +857,15 @@ def __reply_finished(self, callback, *args, **kwargs):
reply.deleteLater()

def __create_progress_dialog(self, text, filesize):
""" Creates a progress dialog.
""" Creates a progress dialog. Uses manager.progress_icon (if set) to
determine which icon to display on the dialog.
Parameters
----------
text : str
The label to display on the dialog
filesize : int
The size of the file being transfered in bytes
windowIcon : QIcon
The icon which the progress dialog should show
windowTitle : str
The text next to the icon (relevant for Windows only)
Returns
-------
Expand Down

0 comments on commit 49b797a

Please sign in to comment.