changeset 38509:5cfb01d5ff26

repository: document that file() return value conforms to interface Differential Revision: https://phab.mercurial-scm.org/D3867
author Gregory Szorc <gregory.szorc@gmail.com>
date Sat, 30 Jun 2018 15:51:04 -0700
parents 39db5a01cd53
children 561a450c7b64
files mercurial/repository.py
diffstat 1 files changed, 4 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/repository.py	Sun Jul 01 21:40:55 2018 +0900
+++ b/mercurial/repository.py	Sat Jun 30 15:51:04 2018 -0700
@@ -863,7 +863,10 @@
         """Calls self.vfs.reljoin(self.root, f, *insidef)"""
 
     def file(f):
-        """Obtain a filelog for a tracked path."""
+        """Obtain a filelog for a tracked path.
+
+        The returned type conforms to the ``ifilestorage`` interface.
+        """
 
     def setparents(p1, p2):
         """Set the parent nodes of the working directory."""