b.h.RegisteredTopic(object) : class documentation

Part of bzrlib.help_topics View In Hierarchy

A help topic which has been registered in the HelpTopicRegistry.

These topics consist of nothing more than the name of the topic - all data is retrieved on demand from the registry.

Method __init__ Constructor.
Method get_help_text Return a string with the help for this topic.
Method get_help_topic Return the help topic this can be found under.
def __init__(self, topic):
Constructor.
ParameterstopicThe name of the topic that this represents.
def get_help_text(self, additional_see_also=None, plain=True):
Return a string with the help for this topic.
Parametersadditional_see_alsoAdditional help topics to be cross-referenced.
plainif False, raw help (reStructuredText) is returned instead of plain text.
def get_help_topic(self):
Return the help topic this can be found under.
API Documentation for Bazaar, generated by pydoctor at 2019-07-19 00:30:15.