fixed docstrings

[findit] / src / findit.py

diff --git a/src/findit.py b/src/findit.py
index 99eaecb..09feebd 100755 (executable)
--- a/src/findit.py
+++ b/src/findit.py
@@ -36,9 +36,7 @@ except IOError:
 
 # Функция которая возвращает строку из числа и единиц для столбца "Размер"("Size")
 def size_convert(size):
-    """This function return string with file size in
-    b or Kb or Mb or Gb or Tb
-    """
+    """Return string with file size in b or Kb or Mb or Gb or Tb."""
     for i, unit in enumerate(['%d b', '%.1f Kb', '%.2f Mb', '%.3f Gb', '%.4f Tb']):
         if size < 1024**(i+1):
             return unit % (size/1024.**i)
@@ -46,9 +44,7 @@ def size_convert(size):
 
 # Функция поставляющая размер файла и путь к нему
 def filegetter(startdir, obj):
-    """This function-generator return size 
-    and path for all files in start directory
-    """
+    """Generator of file sizes and paths based on os.walk."""
     # Список игнорируемых каталогов:
     ignore_dirs = ['/dev', '/proc', '/sys', '/mnt']
     # Проходим по всем папкам вглубь от заданного пути
@@ -80,7 +76,7 @@ def filegetter(startdir, obj):
 
 # Fullscreen
 def toggle_fullscreen(obj):
-    """This function switch and unswitch to fullscreen"""
+    """Switch fullscreen on/off."""
     if obj.fullscreen:
         obj.window.unfullscreen()
     else: 
@@ -89,16 +85,18 @@ def toggle_fullscreen(obj):
 
 # Нажатие на кнопку клавиатуры
 def on_key_press(obj, event):
-    """This function start then FullScreen button on N8xx pressed"""
+    """Key press callback."""
+    # Toggle fullscreen on Maemo when hw key is pressed
     if hildonFound and event.keyval == gtk.keysyms.F6:
         toggle_fullscreen(obj)
 
 ### Properties dialog ##########################################################
 
 class PropertiesDialog(gtk.Dialog):
-    """This class describe property window"""
+    """File property dialog window."""
+
     def __init__(self, path, size, bytesize):
-        """Creating new object of PropertiesDialog class"""
+        """Create&show file properties dialog."""
         gtk.Dialog.__init__(self)
         self.set_title( _('File properties') )
         self.set_transient_for(app)
@@ -151,11 +149,11 @@ class PropertiesDialog(gtk.Dialog):
 ### Main window ################################################################
 
 class MainWindow(gtk.Window):
-    """This class describe main window of FindIT"""
+    """Main window class."""
 
     # Окно сообщения заданного типа с заданным текстом
     def mess_window(self, mestype, content):
-        """This function show popup message window"""
+        """Show popup message window."""
         dialog = gtk.MessageDialog(parent=self, flags=gtk.DIALOG_MODAL,
                                    type=mestype, buttons=gtk.BUTTONS_OK,
                                    message_format=content)
@@ -166,9 +164,7 @@ class MainWindow(gtk.Window):
 
     # Функция выполняющаяся при нажатии на кнопку "Показать"
     def start_print(self, widget):
-        """This function start then "Go" button pressed.
-        Starting file search.               
-        """
+        """Start file search. Button "Go" activate callback."""         
         self.start_path = self.srch_p_entr.get_text()
         # Проверяем правильное ли значение введено
         if isdir(self.start_path):
@@ -203,14 +199,12 @@ class MainWindow(gtk.Window):
 
     # Функция выполняющаяся при нажатии на кнопку "Стоп"
     def stop_print(self, widget):
-        """This function start then "Stop" button pressed.
-        Stoping file search.
-        """
+        """Stop search. "Stop" button clicked callback."""
         self.stopit = True
 
     # Функция выполняющаяся при нажатии на кнопку "Свойства файла"
     def show_properties_dialog(self, *args):
-        """This function show property window"""
+        """Show property dialog window."""
         selection = self.treeview.get_selection()
         (model, it) = selection.get_selected()
         try:
@@ -225,7 +219,7 @@ class MainWindow(gtk.Window):
     ### Window initialization ##################################################
 
     def __init__(self, win_width, win_height, st_path):
-        """Creating new object of MainWindow class"""
+        """Create MainWindow."""
         # Создаем новое окно
         gtk.Window.__init__(self)
         self.set_default_size(win_width, win_height)
@@ -346,7 +340,7 @@ class MainWindow(gtk.Window):
         self.add(main_Vbox)
 
     def run(self):
-        """This function show main window of FindIT"""
+        """Show all widgets and run gtk.main()."""
         self.show_all()
         gtk.main()