b.h.HelpTopicRegistry(registry.Registry) : class documentation

Part of bzrlib.help_topics View In Hierarchy

A Registry customized for handling help topics.
Method register Register a new help topic.
Method register_lazy Register a new help topic, and import the details on demand.
Method get_detail Get the detailed help on a given topic.
Method get_summary Get the single line summary for the topic.
Method get_section Get the section for the topic.
Method get_topics_for_section Get the set of topics in a section.

Inherited from Registry:

Method __init__ Create a new Registry.
Method get Return the object register()'ed to the given key.
Method get_prefix Return an object whose key is a prefix of the supplied value.
Method get_help Get the help text associated with the given key
Method get_info Get the extra information associated with the given key
Method remove Remove a registered entry.
Method __contains__ Undocumented
Method keys Get a list of registered entries
Method iteritems Undocumented
Method items Undocumented
Method _add_help_and_info Add the help and information about this key
Method _get_module Return the module the object will be or was loaded from.
Method _get_key_or_default Return either 'key' or the default key if key is None
Method _set_default_key Undocumented
Method _get_default_key Undocumented
def register(self, topic, detail, summary, section=SECT_LIST):
Register a new help topic.
ParameterstopicName of documentation entry
detailFunction or string object providing detailed documentation for topic. Function interface is detail(topic). This should return a text string of the detailed information. See the module documentation for details on help text formatting.
summaryString providing single-line documentation for topic.
sectionSection in reference manual - see SECT_* identifiers.
def register_lazy(self, topic, module_name, member_name, summary, section=SECT_LIST):
Register a new help topic, and import the details on demand.
ParameterstopicName of documentation entry
module_nameThe module to find the detailed help.
member_nameThe member of the module to use for detailed help.
summaryString providing single-line documentation for topic.
sectionSection in reference manual - see SECT_* identifiers.
def get_detail(self, topic):
Get the detailed help on a given topic.
def get_summary(self, topic):
Get the single line summary for the topic.
def get_section(self, topic):
Get the section for the topic.
def get_topics_for_section(self, section):
Get the set of topics in a section.
API Documentation for Bazaar, generated by pydoctor at 2019-06-25 00:20:44.