Prompt: comment only (clafiry completionToCommand uses)

darcs-hash:20080216181620-32816-0829370170cd174d12c57bc9e2fdfff1c6e65ab2.gz

1 files changed, 7 insertions, 5 deletions

diff --git a/XMonad/Prompt.hs b/XMonad/Prompt.hs
index b56ce4b..459481d 100644
--- a/XMonad/Prompt.hs
+++ b/XMonad/Prompt.hs
@@ -140,11 +140,13 @@ class XPrompt t where
     commandToComplete :: t -> String -> String
     commandToComplete _ c = getLastWord c
 
-    -- | If the prompt is using 'getNextOfLastWord' for implementing
-    -- 'nextCompletion' (the default implementation), this method is
-    -- used to process each completion in order to generate the string
-    -- that will be compared with the command presently displayed in
-    -- the command line.
+    -- | This method is used to process each completion in order to
+    -- generate the string that will be compared with the command
+    -- presently displayed in the command line. If the prompt is using
+    -- 'getNextOfLastWord' for implementing 'nextCompletion' (the
+    -- default implementation), this method is also used to generate,
+    -- from the returned completion, the string that will form the
+    -- next command line when tab is pressed.
     completionToCommand :: t -> String -> String
     completionToCommand _ c = c