summaryrefslogtreecommitdiff
path: root/include/git2/stash.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/git2/stash.h')
-rw-r--r--include/git2/stash.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/include/git2/stash.h b/include/git2/stash.h
index 070aa9b76..bb17933bc 100644
--- a/include/git2/stash.h
+++ b/include/git2/stash.h
@@ -96,7 +96,9 @@ typedef enum {
* @param repo The owning repository.
* @param index The position within the stash list. 0 points to the
* most recent stashed state.
- * @param checkout_options Options to control how files are checked out
+ * @param checkout_options Options to control how files are checked out.
+ * A minimum strategy of `GIT_CHECKOUT_SAFE` is
+ * implied.
* @param flags Flags to control the applying process. (see GIT_APPLY_* above)
*
* @return 0 on success, GIT_ENOTFOUND if there's no stashed state for the