Rev 2441: Expand HelpContexts documentation. in file:///home/robertc/source/baz/help-contexts/

[Robert Collins]

At file:///home/robertc/source/baz/help-contexts/

------------------------------------------------------------
revno: 2441
revision-id: robertc at robertcollins.net-20070420005034-4z8nhh9x6nml05j2
parent: robertc at robertcollins.net-20070420004517-w6lqtu5vz2lli7av
committer: Robert Collins <robertc at robertcollins.net>
branch nick: help-contexts
timestamp: Fri 2007-04-20 10:50:34 +1000
message:
  Expand HelpContexts documentation.
modified:
  bzrlib/help.py                 help.py-20050505025907-4dd7a6d63912f894
=== modified file 'bzrlib/help.py'
--- a/bzrlib/help.py	2007-04-20 00:34:03 +0000
+++ b/bzrlib/help.py	2007-04-20 00:50:34 +0000
@@ -183,7 +183,17 @@
 
 
 class HelpContexts(object):
-    """An object to manage help in multiple contexts."""
+    """An object to manage help in multiple contexts.
+    
+    This maintains a list of places to search for help. It is currently
+    separate to the HelpTopicRegistry because of its ordered nature, but
+    possibly we should instread structure it as a search within the registry
+    and add ordering and searching facilities to the registry. The registry
+    would probably need to be restructured to support that cleanly which is
+    why this has been implemented in parallel even though it does as a result
+    permit searching for help in contexts which are not discoverable via
+    'help topics'.
+    """
 
     def __init__(self):
         self.search_path = [