Commit 37421e1
committed
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).1 parent ca2ab61 commit 37421e1
1 file changed
Lines changed: 3 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -65,13 +65,10 @@ def __exit__( | |||
| 65 | 65 | ||
| 66 | 66 | ||
| 67 | 67 | 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. | ||
| 71 | 69 | ||
| 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. | ||
| 75 | 72 | """ | |
| 76 | 73 | ||
| 77 | 74 | @wraps(func) | |
0 commit comments