# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@octobus.net>
# Date 1695157996 -7200
# Node ID 569eb5d0420df2dc131b3bb7b3424019a6d2c50c
# Parent  39fa0b948f5a8ebffbce4e67519d0c3ba4d65199
revlog: document the `update_caches` method

A small docstring does not hurt.

diff -r 39fa0b948f5a -r 569eb5d0420d 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)