~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Robert Collins
  • Date: 2007-04-20 00:50:34 UTC
  • mto: This revision was merged to the branch mainline in revision 2441.
  • Revision ID: robertc@robertcollins.net-20070420005034-4z8nhh9x6nml05j2
Expand HelpContexts documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
183
183
 
184
184
 
185
185
class HelpContexts(object):
186
 
    """An object to manage help in multiple contexts."""
 
186
    """An object to manage help in multiple contexts.
 
187
    
 
188
    This maintains a list of places to search for help. It is currently
 
189
    separate to the HelpTopicRegistry because of its ordered nature, but
 
190
    possibly we should instread structure it as a search within the registry
 
191
    and add ordering and searching facilities to the registry. The registry
 
192
    would probably need to be restructured to support that cleanly which is
 
193
    why this has been implemented in parallel even though it does as a result
 
194
    permit searching for help in contexts which are not discoverable via
 
195
    'help topics'.
 
196
    """
187
197
 
188
198
    def __init__(self):
189
199
        self.search_path = [