b.p.ModuleHelpTopic(object) : class documentation

Part of bzrlib.plugin View In Hierarchy

A help topic which returns the docstring for a module.
Method __init__ Constructor.
Method get_help_text Return a string with the help for this topic.
Method get_help_topic Return the module help topic: its basename.
def __init__(self, module):
Constructor.
ParametersmoduleThe module for which help should be generated.
def get_help_text(self, additional_see_also=None, verbose=True):
Return a string with the help for this topic.
Parametersadditional_see_alsoAdditional help topics to be cross-referenced.
def get_help_topic(self):
Return the module help topic: its basename.
API Documentation for Bazaar, generated by pydoctor at 2014-08-29 00:01:11.