D1375: bundlerepo: add docstring for bundlerepository class

[indygreg (Gregory Szorc)]

This revision was automatically updated to reflect the committed changes.
Closed by commit rHGd2458ba810c5: bundlerepo: add docstring for bundlerepository class (authored by indygreg, committed by ).

REPOSITORY
  rHG Mercurial

CHANGES SINCE LAST UPDATE
  https://phab.mercurial-scm.org/D1375?vs=3430&id=3452

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

AFFECTED FILES
  mercurial/bundlerepo.py

CHANGE DETAILS

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:



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