Doc: Clarify description of stash_unstaged_changes

greenbone · Nov 13, 2024 · 0e77d6e · 0e77d6e
1 parent 098b784
commit 0e77d6e
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/autohooks/api/git.py b/autohooks/api/git.py
@@ -333,9 +333,13 @@ def _apply_diff(patch: bytes) -> None:
 
 class stash_unstaged_changes:  # pylint: disable=invalid-name
     """
-    A context manager that stashes changes on tracked files that are not added
-    to the index. The stashed changes are restored when the context manager
-    exits.
+    A context manager that stashes changes that
+        - are not staged, and
+        - affect files that are partially staged.
+    Changes that are made before the context manager exits, are added to the
+    index.
+
+    The stashed changes are restored when the context manager exits.
 
     Example: ::