[RFC] bzr help plugin-name

[Martin Pool]

On 20 Jun 2006, Robert Collins <robertc at robertcollins.net> wrote:
> On Mon, 2006-06-19 at 10:37 -0500, John Arbash Meinel wrote:
> > Robert Collins wrote:
> > > I think it would be nice if 'bzr help <pluginname>' were to show the
> > > docstring from the plugin. This would allow plugins that introduce a
> > > number of commands to have a single place to give conceptual guidance
> > > and help - one that users can be taught how to predict.
> > > 
> > > Rob
> > 
> > This goes back into having plugins export a 'canonical' name. Otherwise
> > I may work like mpe and have 01_shelf, or bzrtools-baz2bzr, or
> > bzrtools-lifeless, etc.

I can see there are cases such as yourself it's useful but I do think
it's a bit of an advanced use, and I think for most instances people
should just call the directory by its canonical name.

Would it be enough for those modules to do something like (pseudocode)

  sys.modules['bzrlib.plugins.guisupport'] == __module__

?

> > But I agree, it would be nice to have 'bzr help pluginname'.
> > Maybe 'bzr help plugins.<pluginname>' to disambiguate for plugins that
> > export commands of the same name.
> > 
> > Or 'bzr help --plugin <pluginname>' or 'bzr help plugin <pluginname>'
> > 
> > I probably like the last one the most.
> 
> I'm fine with the last one, but prefer 'bzr help <pluginname>' with 'bzr
> help plugin <pluginname>' as an additional syntax people can use if they
> need to disambiguate.

+1

-- 
Martin