repoview: update documentation of _getstatichidden
In
2f7cb6e6acdd, the function name, role and return was changed. But the
documentation was not. This fixes it.
--- a/mercurial/repoview.py Sat Apr 04 14:56:18 2015 +0900
+++ b/mercurial/repoview.py Fri Apr 03 13:58:12 2015 -0700
@@ -23,10 +23,16 @@
return obsolete.getrevs(repo, 'obsolete')
def _getstatichidden(repo):
- """Cacheable revisions blocking hidden changesets from being filtered.
+ """Revision to be hidden (disregarding dynamic blocker)
- Additional non-cached hidden blockers are computed in _getdynamicblockers.
- This is a standalone function to help extensions to wrap it."""
+ To keep a consistent graph, we cannot hide any revisions with
+ non-hidden descendants. This function computes the set of
+ revisions that could be hidden while keeping the graph consistent.
+
+ A second pass will be done to apply "dynamic blocker" like bookmarks or
+ working directory parents.
+
+ """
assert not repo.changelog.filteredrevs
hideable = hideablerevs(repo)
if hideable: