# HG changeset patch
# User paulb
# Date 1197922778 0
# Node ID 0e0290004d920193d5c7e1a4e249700d06600d53
# Parent  fbb8e6877c7ad24ca552fcd9a4bfd3017f3cd2cb
[project @ 2007-12-17 20:19:38 by paulb]
Improved docstrings.

diff -r fbb8e6877c7a -r 0e0290004d92 desktop/dialog.py
--- a/desktop/dialog.py	Mon Dec 17 20:15:37 2007 +0000
+++ b/desktop/dialog.py	Mon Dec 17 20:19:38 2007 +0000
@@ -264,6 +264,10 @@
         indicating selections of one or more items (for RadioList, CheckList),
         or a value indicating true or false (for Question, Warning, Message,
         Error).
+
+        Where a string value may be expected but no choice is made, an empty
+        string may be returned. Similarly, where a list of values is expected
+        but no choice is made, an empty list may be returned.
         """
 
         # Decide on the desktop environment in use.
@@ -518,7 +522,8 @@
     """
     A text file input box.
     Options: filename, text, width (in characters), height (in characters)
-    Response: any text returned by the dialogue program
+    Response: any text returned by the dialogue program (typically an empty
+              string)
     """
 
     name = "textfile"