revlog: document the `update_caches` method
authorPierre-Yves David <pierre-yves.david@octobus.net>
Tue, 19 Sep 2023 23:13:16 +0200
changeset 51005 569eb5d0420d
parent 51004 39fa0b948f5a
child 51006 6c3798b4597f
revlog: document the `update_caches` method A small docstring does not hurt.
mercurial/revlog.py
--- a/mercurial/revlog.py	Tue Sep 19 23:10:05 2023 +0200
+++ b/mercurial/revlog.py	Tue Sep 19 23:13:16 2023 +0200
@@ -908,6 +908,10 @@
         return True
 
     def update_caches(self, transaction):
+        """update on disk cache
+
+        If a transaction is passed, the update may be delayed to transaction
+        commit."""
         if self._nodemap_file is not None:
             if transaction is None:
                 nodemaputil.update_persistent_nodemap(self)