Patchwork D3867: repository: document that file() return value conforms to interface

login
register
mail settings
Submitter phabricator
Date July 1, 2018, 1:35 a.m.
Message ID <differential-rev-PHID-DREV-zpn33spmieik4ddkqxew-req@phab.mercurial-scm.org>
Download mbox | patch
Permalink /patch/32533/
State Superseded
Headers show

Comments

phabricator - July 1, 2018, 1:35 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/D3867

AFFECTED FILES
  mercurial/repository.py

CHANGE DETAILS




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

Patch

diff --git a/mercurial/repository.py b/mercurial/repository.py
--- a/mercurial/repository.py
+++ b/mercurial/repository.py
@@ -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."""