Patchwork D1375: bundlerepo: add docstring for bundlerepository class

login
register
mail settings
Submitter phabricator
Date Nov. 12, 2017, 2:52 a.m.
Message ID <differential-rev-PHID-DREV-6jl4zj32nvsvkh2jdw5y-req@phab.mercurial-scm.org>
Download mbox | patch
Permalink /patch/25492/
State Superseded
Headers show

Comments

phabricator - Nov. 12, 2017, 2:52 a.m.
indygreg created this revision.
Herald added a subscriber: mercurial-devel.
Herald added a reviewer: hg-reviewers.

REPOSITORY
  rHG Mercurial

REVISION DETAIL
  https://phab.mercurial-scm.org/D1375

AFFECTED FILES
  mercurial/bundlerepo.py

CHANGE DETAILS




To: indygreg, #hg-reviewers
Cc: mercurial-devel

Patch

diff --git a/mercurial/bundlerepo.py b/mercurial/bundlerepo.py
--- a/mercurial/bundlerepo.py
+++ b/mercurial/bundlerepo.py
@@ -256,6 +256,14 @@ 
     return bundlefilespos
 
 class bundlerepository(localrepo.localrepository):
+    """A repository instance that is a union of a local repo and a bundle.
+
+    Instances represent a read-only repository composed of a local repository
+    with the contents of a bundle file applied. The repository instance is
+    conceptually similar to the state of a repository after an
+    ``hg unbundle`` operation. However, the contents of the bundle are never
+    applied to the actual base repository.
+    """
     def __init__(self, ui, repopath, bundlepath):
         self._tempparent = None
         try: