← Back to branch summary

~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 02:48:34 UTC
  • mto: This revision was merged to the branch mainline in revision 2441.
  • Revision ID: robertc@robertcollins.net-20070420024834-aqmgb1fu8qiw73p6
Rename Context (in bzrlib.help) to Index, for a clearer name.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
37
37
    if outfile is None:
38
38
        outfile = sys.stdout
39
39
 
40
 
    contexts = HelpContexts()
41
 
    topics = contexts.search(topic)
 
40
    indexs = HelpIndexs()
 
41
    topics = indexs.search(topic)
42
42
    outfile.write(topics[0].get_help_text())
43
43
 
44
44
 
92
92
                                    "All hidden commands")
93
93
 
94
94
 
95
 
class HelpContexts(object):
96
 
    """An object to manage help in multiple contexts.
 
95
class HelpIndexs(object):
 
96
    """An object to manage help in multiple indexs.
97
97
    
98
98
    This maintains a list of places to search for help. It is currently
99
99
    separate to the HelpTopicRegistry because of its ordered nature, but
101
101
    and add ordering and searching facilities to the registry. The registry
102
102
    would probably need to be restructured to support that cleanly which is
103
103
    why this has been implemented in parallel even though it does as a result
104
 
    permit searching for help in contexts which are not discoverable via
 
104
    permit searching for help in indexs which are not discoverable via
105
105
    'help topics'.
106
106
    """
107
107
 
108
108
    def __init__(self):
109
109
        self.search_path = [
110
 
            help_topics.HelpTopicContext(),
111
 
            _mod_commands.HelpCommandContext(),
 
110
            help_topics.HelpTopicIndex(),
 
111
            _mod_commands.HelpCommandIndex(),
112
112
            ]
113
113
 
114
114
    def search(self, topic):
115
115
        """Search for topic across the help search path.
116
116
        
117
117
        :param topic: A string naming the help topic to search for.
118
 
        :raises: NoHelpTopic if none of the contexts in search_path have topic.
 
118
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
119
119
        :return: A list of HelpTopics which matched 'topic'.
120
120
        """
121
121
        result = []
122
 
        for context in self.search_path:
123
 
            result.extend(context.get_topics(topic))
 
122
        for index in self.search_path:
 
123
            result.extend(index.get_topics(topic))
124
124
        if not result:
125
125
            raise errors.NoHelpTopic(topic)
126
126
        else: