Further revise post_clear_cache docstring

EliahKagan · EliahKagan · commit 37421e1b8f06 · 2024-02-26T15:06:19.000-05:00
For #1847. This removes the note, and splits out some related material from the docstring's top line into a second paragraph for readability (since the first sentence of the top line was complete, and described usage).
diff --git a/git/index/util.py b/git/index/util.py
@@ -65,13 +65,10 @@ def __exit__(
 
 
 def post_clear_cache(func: Callable[..., _T]) -> Callable[..., _T]:
-    """Decorator for functions that alter the index using the git command. This would
-    invalidate our possibly existing entries dictionary which is why it must be deleted
-    to allow it to be lazily reread later.
+    """Decorator for functions that alter the index using the git command.
 
-    :note:
-        This decorator is required because not all functions related to
-        :class:`~git.index.base.IndexFile` are implemented natively.
+    When a git command alters the index, this invalidates our possibly existing entries
+    dictionary, which is why it must be deleted to allow it to be lazily reread later.
     """
 
     @wraps(func)
