[Zope3-checkins] CVS: Zope3/src/zope/app/advanced - query.py:1.3

[Philipp von Weitershausen]

Update of /cvs-repository/Zope3/src/zope/app/advanced
In directory cvs.zope.org:/tmp/cvs-serv10925

Modified Files:
	query.py 
Log Message:
Provide docstring and doctests for the query mechanism.


=== Zope3/src/zope/app/advanced/query.py 1.2 => 1.3 ===
--- Zope3/src/zope/app/advanced/query.py:1.2	Thu Apr  1 12:15:50 2004
+++ Zope3/src/zope/app/advanced/query.py	Thu Apr  1 12:21:56 2004
@@ -11,12 +11,50 @@
 # FOR A PARTICULAR PURPOSE.
 #
 ##############################################################################
-"""
+"""Query mechanism
+
+This module contains advanced core query mechanisms. See the
+docstrings and interfaces.py for more information.
+
 $Id$
 """
 
 def advancedQueryMechanism(arguments,action='query',
                            tabs=''):
+    """
+    Use the advance query mechanism.
+
+    Let's have a look at a typical query session using the mechanism:
+    
+    >>> exit
+    'Use Ctrl-D (i.e. EOF) to exit.'
+    >>> quit
+    'Use Ctrl-D (i.e. EOF) to exit.'
+
+    This is the typical setup if the query fails:
+
+    >>> helpp
+    Traceback (most recent call last):
+    ...
+    NameError: name 'helpp' is not defined
+
+    Of course, you're not gonna get it to work if you continue on this
+    path:
+
+    >>> hello?
+    Traceback (most recent call last):
+    ...
+    SyntaxError: invalid syntax
+    >>> mail employee help this doesn't work
+    Traceback (most recent call last):
+    ...
+    SyntaxError: invalid syntax
+    >>> what is this???
+    Traceback (most recent call last):
+    ...
+    SyntaxError: invalid syntax
+    >>>
+    """
     if arguments:
         items=arguments.items()
         return (