Skip to content

Commit 37421e1

Browse files
committed
Further revise post_clear_cache docstring
For gitpython-developers#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).
1 parent ca2ab61 commit 37421e1

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

Diff for: git/index/util.py

+3-6
Original file line numberDiff line numberDiff line change
@@ -65,13 +65,10 @@ def __exit__(
6565

6666

6767
def post_clear_cache(func: Callable[..., _T]) -> Callable[..., _T]:
68-
"""Decorator for functions that alter the index using the git command. This would
69-
invalidate our possibly existing entries dictionary which is why it must be deleted
70-
to allow it to be lazily reread later.
68+
"""Decorator for functions that alter the index using the git command.
7169
72-
:note:
73-
This decorator is required because not all functions related to
74-
:class:`~git.index.base.IndexFile` are implemented natively.
70+
When a git command alters the index, this invalidates our possibly existing entries
71+
dictionary, which is why it must be deleted to allow it to be lazily reread later.
7572
"""
7673

7774
@wraps(func)

0 commit comments

Comments
 (0)