plugins/launchpad very unhelpful documentation

Bug #589379 reported by James Westby
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Bazaar
Fix Released
Medium
Neil Martinsen-Burrell

Bug Description

Do a

  bzr help launchpad

and you get a nice overview of what Launchpad is. At the bottom it tells you
that you can do

  bzr help plugins/launchpad

which should tell you about the plugin, such as the commands that are provided,
but it doesn't.

The module docstring of bzrlib.plugins.launchpad should be expanded to give
an overview of the plugin, separate from the overview of the service.

Thanks,

James

Tags: doc easy

Related branches

Revision history for this message
Parth Malwankar (parthm) wrote :

This is what `bzr help launchpad` and `bzr help plugins/launchpad` says.

~]% bzr help launchpad
Integration with Launchpad.net

Launchpad.net provides free Bazaar branch hosting with integrated bug and
specification tracking.

The bzr client (through the plugin called 'launchpad') has special
features to communicate with Launchpad:

    * The launchpad-login command tells Bazaar your Launchpad user name. This
      is then used by the 'lp:' transport to download your branches using
      bzr+ssh://.

    * The 'lp:' transport uses Launchpad as a directory service: for example
      'lp:bzr' and 'lp:python' refer to the main branches of the relevant
      projects and may be branched, logged, etc. You can also use the 'lp:'
      transport to refer to specific branches, e.g. lp:~bzr/bzr/trunk.

    * The 'lp:' bug tracker alias can expand launchpad bug numbers to their
      URLs for use with 'bzr commit --fixes', e.g. 'bzr commit --fixes lp:12345'
      will record a revision property that marks that revision as fixing
      Launchpad bug 12345. When you push that branch to Launchpad it will
      automatically be linked to the bug report.

    * The register-branch command tells Launchpad about the url of a
      public branch. Launchpad will then mirror the branch, display
      its contents and allow it to be attached to bugs and other
      objects.

For more information see http://help.launchpad.net/

See also: plugins/launchpad

[~]% bzr help plugins/launchpad
Launchpad.net integration plugin for Bazaar.
[~]%

Changed in bzr:
status: New → Confirmed
importance: Undecided → Medium
tags: added: doc easy
Revision history for this message
Robert Collins (lifeless) wrote : Re: [Bug 589379] Re: plugins/launchpad very unhelpful documentation

Note that the plugin docstring will show up for 'help pluginname' if
there is no specific docs for it, but that isn't [yet]
internationalised.

Vincent Ladeuil (vila)
Changed in bzr:
assignee: nobody → Neil Martinsen-Burrell (nmb)
milestone: none → 2.3b2
status: Confirmed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.