# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@octobus.net>
# Date 2023-09-19 20:52:54
# Node ID 4ea606568f618984ea8bfe39a2696a8691de7b51
# Parent  44001e6f04deedbaffa2a2ab60d9b884b6e8c3dd

revlog: document the `is_inline_index` method

A small docstring does not hurt.

diff --git a/mercurial/revlog.py b/mercurial/revlog.py
--- a/mercurial/revlog.py
+++ b/mercurial/revlog.py
@@ -291,6 +291,7 @@ class revlog:
 
     @staticmethod
     def is_inline_index(header_bytes):
+        """Determine if a revlog is inline from the initial bytes of the index"""
         header = INDEX_HEADER.unpack(header_bytes)[0]
 
         _format_flags = header & ~0xFFFF