Add more documentation, fix commandline slicing.

[cura.git] / Cura / util / explorer.py

diff --git a/Cura/util/explorer.py b/Cura/util/explorer.py
index 35991823070c9abb98a341c05b789b7681072adf..1e2a5a0b21220a34c5fac85ed398e400c602b221 100644 (file)
--- a/Cura/util/explorer.py
+++ b/Cura/util/explorer.py
@@ -1,3 +1,7 @@
+"""
+Simple utility module to open "explorer" file dialogs.
+The name "explorer" comes from the windows file explorer, which is called explorer.
+"""
 __copyright__ = "Copyright (C) 2013 David Braam - Released under terms of the AGPLv3 License"
 
 import sys
@@ -5,6 +9,7 @@ import os
 import subprocess
 
 def hasExplorer():
+       """Check if we have support for opening file dialog windows."""
        if sys.platform == 'win32' or sys.platform == 'cygwin' or sys.platform == 'darwin':
                return True
        if sys.platform == 'linux2':
@@ -15,17 +20,20 @@ def hasExplorer():
        return False
 
 def openExplorer(filename):
+       """Open an file dialog window in the directory of a file, and select the file."""
        if sys.platform == 'win32' or sys.platform == 'cygwin':
                subprocess.Popen(r'explorer /select,"%s"' % (filename))
        if sys.platform == 'darwin':
                subprocess.Popen(['open', '-R', filename])
        if sys.platform.startswith('linux'):
+               #TODO: On linux we cannot seem to select a certain file, only open the specified path.
                if os.path.isfile('/usr/bin/nautilus'):
                        subprocess.Popen(['/usr/bin/nautilus', os.path.split(filename)[0]])
                elif os.path.isfile('/usr/bin/dolphin'):
                        subprocess.Popen(['/usr/bin/dolphin', os.path.split(filename)[0]])
 
 def openExplorerPath(filename):
+       """Open a file dialog inside a directory, without selecting any file."""
        if sys.platform == 'win32' or sys.platform == 'cygwin':
                subprocess.Popen(r'explorer "%s"' % (filename))
        if sys.platform == 'darwin':