From 696362a0f6886dca84a670059e01af6076a218e9 Mon Sep 17 00:00:00 2001
From: Florian Bruhin <git@the-compiler.org>
Date: Wed, 29 Jan 2014 04:16:50 +0100
Subject: [PATCH] Use docstrings instead of desc for command classes

---
 qutebrowser/commands/__init__.py | 61 ++++++++++++++++++++++++--------
 qutebrowser/commands/template.py |  1 -
 qutebrowser/commands/utils.py    |  3 +-
 3 files changed, 48 insertions(+), 17 deletions(-)

diff --git a/qutebrowser/commands/__init__.py b/qutebrowser/commands/__init__.py
index 91875b9e5..5a5f870b2 100644
--- a/qutebrowser/commands/__init__.py
+++ b/qutebrowser/commands/__init__.py
@@ -8,7 +8,7 @@ A command class can set the following properties:
     nargs -- Number of arguments. Either a number, '?' (0 or 1), '+' (1 or
     more), or '*' (any). Default: 0
 
-    name -- The name of the command, or a list of aliases
+    name -- The name of the command, or a list of aliases.
 
     split_args -- If arguments should be split or not. Default: True
 
@@ -16,87 +16,108 @@ A command class can set the following properties:
 
     hide -- If the command should be hidden in tab completion. Default: False
 
-    desc -- Description of the command
+    desc -- Description of the command.
 """
 
 from qutebrowser.commands.template import Command
 
 
 class Open(Command):
+    """Open a page.
+
+    arg: The URL to open.
+    """
+
     nargs = 1
     split_args = False
-    desc = 'Open a page'
 
 
 class TabOpen(Command):
+    """Open a page in a new tab.
+
+    arg: The URL to open.
+    """
+
     nargs = 1
     split_args = False
-    desc = 'Open a page in a new tab'
 
 
 class TabClose(Command):
+    """Close the current tab."""
     nargs = 0
-    desc = 'Close the current tab'
     # FIXME also close [count]th tab
 
 
 class TabNext(Command):
+    """Switch to the next tab."""
     nargs = 0
-    desc = 'Switch to the next tab'
     # FIXME also support [count]
 
 
 class TabPrev(Command):
+    """Switch to the previous tab."""
     nargs = 0
-    desc = 'Switch to the previous tab'
     # FIXME also support [count]
 
 
 class Quit(Command):
+    """Quit qutebrowser."""
     name = ['quit', 'q']
     nargs = 0
-    desc = 'Quit qutebrowser'
 
 
 class Reload(Command):
+    """Reload the current page."""
     nargs = 0
-    desc = 'Reload the current page'
 
 
 class Stop(Command):
+    """Stop loading the current page."""
     nargs = 0
-    desc = 'Stop loading the current page'
 
 
 class Back(Command):
+    """Go back one page in the history."""
     nargs = 0
-    desc = 'Go back one page in the history'
     # FIXME also support [count]
 
 
 class Forward(Command):
+    """Go forward one page in the history."""
     nargs = 0
-    desc = 'Go forward one page in the history'
     # FIXME also support [count]
 
 
 class Print(Command):
+    """Print the current page."""
     nargs = 0
-    desc = 'Print the current page'
 
 
 class Scroll(Command):
+    """Scroll in x/y direction by a number of pixels.
+
+    arg 1: delta x
+    arg 2: delta y
+    count: multiplicator
+    """
+
     nargs = 2
     count = True
     hide = True
 
 
 class Undo(Command):
+    """Undo closing a tab."""
     nargs = 0
-    desc = 'Undo closing a tab'
 
 
 class ScrollPercX(Command):
+    """Scroll N percent horizontally.
+
+    optional arg: How many percent to scroll.
+    count: How many percent to scroll.
+    """
+
     nargs = '?'
     count = True
     hide = True
@@ -104,6 +125,12 @@ class ScrollPercX(Command):
 
 
 class ScrollPercY(Command):
+    """Scroll N percent vertically.
+
+    optional arg: How many percent to scroll.
+    count: How many percent to scroll.
+    """
+
     nargs = '?'
     count = True
     hide = True
@@ -111,6 +138,10 @@ class ScrollPercY(Command):
 
 
 class PyEval(Command):
+    """Evaluate python code.
+
+    arg: The python code to evaluate.
+    """
+
     nargs = 1
     split_args = False
-    desc = 'Evaluate python code'
diff --git a/qutebrowser/commands/template.py b/qutebrowser/commands/template.py
index d098a46b2..c0a48c797 100644
--- a/qutebrowser/commands/template.py
+++ b/qutebrowser/commands/template.py
@@ -22,7 +22,6 @@ class Command(QObject):
     split_args = True
     signal = pyqtSignal(tuple)
     hide = False
-    desc = ""  # FIXME add descriptions everywhere
 
     def __init__(self):
         super().__init__()
diff --git a/qutebrowser/commands/utils.py b/qutebrowser/commands/utils.py
index 5772afcdf..a3e7b26e9 100644
--- a/qutebrowser/commands/utils.py
+++ b/qutebrowser/commands/utils.py
@@ -96,6 +96,7 @@ class CommandCompletionModel(CompletionModel):
         cmdlist = []
         for obj in set(cmd_dict.values()):
             if not obj.hide:
-                cmdlist.append([obj.mainname, obj.desc])
+                doc = obj.__doc__.splitlines()[0].strip().rstrip('.')
+                cmdlist.append([obj.mainname, doc])
         self._data['Commands'] = sorted(cmdlist)
         self.init_data()