← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/controldir.py

  • Committer: Jelmer Vernooij
  • Date: 2010-08-02 14:14:13 UTC
  • mto: This revision was merged to the branch mainline in revision 5389.
  • Revision ID: jelmer@samba.org-20100802141413-z1bti7u0mtwdx1i6
Docstrings.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/controldir.py
702
702
 
703
703
 
704
704
class Prober(object):
 
705
    """Abstract class that can be used to detect a particular kind of 
 
706
    control directory.
 
707
 
 
708
    At the moment this just contains a single method to probe a particular 
 
709
    transport, but it may be extended in the future to e.g. avoid 
 
710
    multiple levels of probing for Subversion repositories.
 
711
    """
705
712
 
706
713
    def probe_transport(self, transport):
707
 
        """Return the controldir style format present in a directory."""
 
714
        """Return the controldir style format present in a directory.
 
715
 
 
716
        :raise UnknownFormatError: If a control dir was found but is
 
717
            in an unknown format.
 
718
        :raise NotBranchError: If no control directory was found.
 
719
        :return: A ControlDirFormat instance.
 
720
        """
708
721
        raise NotImplementedError(self.probe_transport)
709
722
 
710
723