b.h.HelpIndices(object) : class documentation

Part of bzrlib.help View In Hierarchy

Maintainer of help topics across multiple indices.

It is currently separate to the HelpTopicRegistry because of its ordered nature, but possibly we should instead 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 indices which are not discoverable via 'help topics'.

Each index has a unique prefix string, such as "commands", and contains help topics which can be listed or searched.

Method __init__ Undocumented
Method search Search for topic across the help search path.
Method _check_prefix_uniqueness Ensure that the index collection is able to differentiate safely.
def __init__(self):
Undocumented
def _check_prefix_uniqueness(self):
Ensure that the index collection is able to differentiate safely.
def search(self, topic):
Search for topic across the help search path.
ParameterstopicA string naming the help topic to search for.
ReturnsA list of HelpTopics which matched 'topic'.
RaisesNoHelpTopic if none of the indexs in search_path have topic.
API Documentation for Bazaar, generated by pydoctor at 2021-10-21 00:29:00.