From 37421e1b8f0618e1d4e5bd322aeb60d23b58e1b9 Mon Sep 17 00:00:00 2001 From: Eliah Kagan Date: Mon, 26 Feb 2024 15:06:19 -0500 Subject: [PATCH] Further revise post_clear_cache docstring 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). --- git/index/util.py | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/git/index/util.py b/git/index/util.py index 347e8747f..0bad11571 100644 --- 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)