Mercurial > public > mercurial-scm > hg
diff mercurial/manifest.py @ 24925:d9832a12a06e
manifest: document return type of readfast()
I keep having to ponder out what readfast() means, and it always
surprises me. Document the return type in the docstring so that future
readers won't have to puzzle this out again.
| author | Augie Fackler <augie@google.com> |
|---|---|
| date | Tue, 28 Apr 2015 12:31:30 -0400 |
| parents | 055b3cbe6c57 |
| children | 48583a1e44f3 |
line wrap: on
line diff
--- a/mercurial/manifest.py Sat Oct 11 01:17:40 2014 -0700 +++ b/mercurial/manifest.py Tue Apr 28 12:31:30 2015 -0400 @@ -793,7 +793,13 @@ return self._newmanifest(d) def readfast(self, node): - '''use the faster of readdelta or read''' + '''use the faster of readdelta or read + + This will return a manifest which is either only the files + added/modified relative to p1, or all files in the + manifest. Which one is returned depends on the codepath used + to retrieve the data. + ''' r = self.rev(node) deltaparent = self.deltaparent(r) if deltaparent != revlog.nullrev and deltaparent in self.parentrevs(r):