← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-05-19 10:51:37 UTC
  • mfrom: (5891.1.3 api-docs)
  • Revision ID: pqm@pqm.ubuntu.com-20110519105137-amzagrral2ldm1lq
(spiv) Fix the formatting of more docstrings. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
454
454
            after. If None, the rest of history is included.
455
455
        :param stop_rule: if stop_revision_id is not None, the precise rule
456
456
            to use for termination:
 
457
 
457
458
            * 'exclude' - leave the stop revision out of the result (default)
458
459
            * 'include' - the stop revision is the last item in the result
459
460
            * 'with-merges' - include the stop revision and all of its
461
462
            * 'with-merges-without-common-ancestry' - filter out revisions 
462
463
              that are in both ancestries
463
464
        :param direction: either 'reverse' or 'forward':
 
465
 
464
466
            * reverse means return the start_revision_id first, i.e.
465
467
              start at the most recent revision and go backwards in history
466
468
            * forward returns tuples in the opposite order to reverse.
1417
1419
        :param to_location: The url to produce the checkout at
1418
1420
        :param revision_id: The revision to check out
1419
1421
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1420
 
        produce a bound branch (heavyweight checkout)
 
1422
            produce a bound branch (heavyweight checkout)
1421
1423
        :param accelerator_tree: A tree which can be used for retrieving file
1422
1424
            contents more quickly than the revision tree, i.e. a workingtree.
1423
1425
            The revision tree will be used for cases where accelerator_tree's