← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Andrew Bennetts
  • Date: 2011-05-18 16:42:48 UTC
  • mto: This revision was merged to the branch mainline in revision 5895.
  • Revision ID: andrew.bennetts@canonical.com-20110518164248-o84lxxjpbn1ib6zv
Fix a bunch of docstring formatting nits, making pydoctor a bit happier.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
1469
1469
 
1470
1470
    def reference_parent(self, file_id, path, possible_transports=None):
1471
1471
        """Return the parent branch for a tree-reference file_id
 
1472
 
1472
1473
        :param file_id: The file_id of the tree reference
1473
1474
        :param path: The path of the file_id in the tree
1474
1475
        :return: A branch associated with the file_id
1864
1865
 
1865
1866
 
1866
1867
class ChangeBranchTipParams(object):
1867
 
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1868
    """Object holding parameters passed to `*_change_branch_tip` hooks.
1868
1869
 
1869
1870
    There are 5 fields that hooks may wish to access:
1870
1871
 
1902
1903
 
1903
1904
 
1904
1905
class BranchInitHookParams(object):
1905
 
    """Object holding parameters passed to *_branch_init hooks.
 
1906
    """Object holding parameters passed to `*_branch_init` hooks.
1906
1907
 
1907
1908
    There are 4 fields that hooks may wish to access:
1908
1909
 
1942
1943
 
1943
1944
 
1944
1945
class SwitchHookParams(object):
1945
 
    """Object holding parameters passed to *_switch hooks.
 
1946
    """Object holding parameters passed to `*_switch` hooks.
1946
1947
 
1947
1948
    There are 4 fields that hooks may wish to access:
1948
1949
 
3390
3391
 
3391
3392
        This is the basic concrete implementation of push()
3392
3393
 
3393
 
        :param _override_hook_source_branch: If specified, run
3394
 
        the hooks passing this Branch as the source, rather than self.
3395
 
        This is for use of RemoteBranch, where push is delegated to the
3396
 
        underlying vfs-based Branch.
 
3394
        :param _override_hook_source_branch: If specified, run the hooks
 
3395
            passing this Branch as the source, rather than self.  This is for
 
3396
            use of RemoteBranch, where push is delegated to the underlying
 
3397
            vfs-based Branch.
3397
3398
        """
3398
3399
        if lossy:
3399
3400
            raise errors.LossyPushToSameVCS(self.source, self.target)