← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-05-28 00:25:32 UTC
  • mfrom: (5264.1.2 command-help-bug-177500)
  • Revision ID: pqm@pqm.ubuntu.com-20100528002532-9bzj1fajyxckd1rg
(lifeless) Stop raising at runtime when a command has no help,
 instead have a test in the test suite that checks all known command objects.
 (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
397
397
            will not mangled.
398
398
 
399
399
    :cvar hooks: An instance of CommandHooks.
 
400
    :ivar __doc__: The help shown by 'bzr help command' for this command.
 
401
        This is set by assigning explicitly to __doc__ so that -OO can
 
402
        be used::
 
403
 
 
404
        class Foo(Command):
 
405
            __doc__ = "My help goes here"
400
406
    """
401
407
    aliases = []
402
408
    takes_args = []
407
413
 
408
414
    def __init__(self):
409
415
        """Construct an instance of this command."""
410
 
        if self.__doc__ == Command.__doc__ or not self.__doc__:
411
 
            raise ValueError("No help message set for %r" % self)
412
416
        # List of standard options directly supported
413
417
        self.supported_std_options = []
414
418
        self._setup_run()
482
486
            message explaining how to obtain full help.
483
487
        """
484
488
        doc = self.help()
485
 
        if doc is None:
486
 
            raise NotImplementedError(
487
 
                "self.help() returned None -  no detailed help yet for %r" %
488
 
                self.name())
 
489
        if not doc:
 
490
            doc = "No help for this command."
489
491
 
490
492
        # Extract the summary (purpose) and sections out from the text
491
493
        purpose,sections,order = self._get_help_parts(doc)