r15935 - /branches/uf_redesign/prompt/help.py -- May 03, 2012 - 22:20

Author: bugman
Date: Thu May  3 22:20:30 2012
New Revision: 15935

URL: http://svn.gna.org/viewcvs/relax?rev=15935&view=rev
Log:
Documented the prompt-based help system _Helper.__call__() method.


Modified:
    branches/uf_redesign/prompt/help.py

Modified: branches/uf_redesign/prompt/help.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/uf_redesign/prompt/help.py?rev=15935&r1=15934&r2=15935&view=diff
==============================================================================
--- branches/uf_redesign/prompt/help.py (original)
+++ branches/uf_redesign/prompt/help.py Thu May  3 22:20:30 2012
@@ -66,12 +66,19 @@
 
 
     def __call__(self, *args, **kwds):
+        """Make the object executable."""
+
+        # Catch strange callings of the object.
         if len(args) != 1 or isinstance(args[0], str):
             print((self.text))
             return
+
+        # The relax help system.
         if hasattr(args[0], '__relax_help__'):
             sys.stdout.write(args[0].__relax_help__ + "\n")
             return
+
+        # Default to the normal Python help system.
         return pydoc.help(*args, **kwds)