← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.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/workingtree.py
230
230
        """True if filename is the name of a control file in this tree.
231
231
 
232
232
        :param filename: A filename within the tree. This is a relative path
233
 
        from the root of this tree.
 
233
            from the root of this tree.
234
234
 
235
235
        This is true IF and ONLY IF the filename is part of the meta data
236
236
        that bzr controls in this tree. I.E. a random .bzr directory placed
626
626
        and setting the list to its value plus revision_id.
627
627
 
628
628
        :param revision_id: The revision id to add to the parent list. It may
629
 
        be a ghost revision as long as its not the first parent to be added,
630
 
        or the allow_leftmost_as_ghost parameter is set True.
 
629
            be a ghost revision as long as its not the first parent to be
 
630
            added, or the allow_leftmost_as_ghost parameter is set True.
631
631
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
632
632
        """
633
633
        parents = self.get_parent_ids() + [revision_id]
1478
1478
        - Restore the wt.basis->wt.state changes.
1479
1479
 
1480
1480
        There isn't a single operation at the moment to do that, so we:
 
1481
 
1481
1482
        - Merge current state -> basis tree of the master w.r.t. the old tree
1482
1483
          basis.
1483
1484
        - Do a 'normal' merge of the old branch basis if it is relevant.
1738
1739
    def _walkdirs(self, prefix=""):
1739
1740
        """Walk the directories of this tree.
1740
1741
 
1741
 
           :prefix: is used as the directrory to start with.
1742
 
           returns a generator which yields items in the form:
1743
 
                ((curren_directory_path, fileid),
1744
 
                 [(file1_path, file1_name, file1_kind, None, file1_id,
1745
 
                   file1_kind), ... ])
 
1742
        :param prefix: is used as the directrory to start with.
 
1743
        :returns: a generator which yields items in the form::
 
1744
 
 
1745
            ((curren_directory_path, fileid),
 
1746
             [(file1_path, file1_name, file1_kind, None, file1_id,
 
1747
               file1_kind), ... ])
1746
1748
        """
1747
1749
        raise NotImplementedError(self._walkdirs)
1748
1750
 
1754
1756
        are considered 'resolved', because bzr always puts conflict markers
1755
1757
        into files that have text conflicts.  The corresponding .THIS .BASE and
1756
1758
        .OTHER files are deleted, as per 'resolve'.
 
1759
 
1757
1760
        :return: a tuple of ConflictLists: (un_resolved, resolved).
1758
1761
        """
1759
1762
        un_resolved = _mod_conflicts.ConflictList()
2911
2914
    def _walkdirs(self, prefix=""):
2912
2915
        """Walk the directories of this tree.
2913
2916
 
2914
 
           :prefix: is used as the directrory to start with.
2915
 
           returns a generator which yields items in the form:
2916
 
                ((curren_directory_path, fileid),
2917
 
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2918
 
                   file1_kind), ... ])
 
2917
        :param prefix: is used as the directrory to start with.
 
2918
        :returns: a generator which yields items in the form::
 
2919
 
 
2920
            ((curren_directory_path, fileid),
 
2921
             [(file1_path, file1_name, file1_kind, None, file1_id,
 
2922
               file1_kind), ... ])
2919
2923
        """
2920
2924
        _directory = 'directory'
2921
2925
        # get the root in the inventory