repository: clarify role of imanifestlog
authorGregory Szorc <gregory.szorc@gmail.com>
Fri, 10 Aug 2018 13:59:27 -0700
changeset 39240 2af6b2d8d1d8
parent 39239 0617a700ef7b
child 39241 aad4b46e89bb
repository: clarify role of imanifestlog Looking at the implementation of manifest.manifestlog, it is highly tailored towards servicing the root manifest. So clarify that in the interface docstring. Differential Revision: https://phab.mercurial-scm.org/D4273
mercurial/repository.py
--- a/mercurial/repository.py	Fri Aug 10 13:43:26 2018 -0700
+++ b/mercurial/repository.py	Fri Aug 10 13:59:27 2018 -0700
@@ -989,7 +989,13 @@
         """
 
 class imanifestlog(interfaceutil.Interface):
-    """Interface representing a collection of manifest snapshots."""
+    """Interface representing a collection of manifest snapshots.
+
+    Represents the root manifest in a repository.
+
+    Also serves as a means to access nested tree manifests and to cache
+    tree manifests.
+    """
 
     def __getitem__(node):
         """Obtain a manifest instance for a given binary node.